WC_Admin_List_Table_Coupons
extends WC_Admin_List_Table
in package
WC_Admin_List_Table_Coupons Class.
Table of Contents
- $list_table_type : string
- Post type.
- $object : object|null
- Object being shown on the row.
- __construct() : mixed
- Constructor.
- default_hidden_columns() : array<string|int, mixed>
- Adjust which columns are displayed by default.
- define_bulk_actions() : array<string|int, mixed>
- Define bulk actions.
- define_columns() : array<string|int, mixed>
- Define which columns to show on this screen.
- define_sortable_columns() : array<string|int, mixed>
- Define which columns are sortable.
- disable_view_mode() : array<string|int, mixed>
- Removes this type from list of post types that support "View Mode" switching.
- handle_bulk_actions() : string
- Handle bulk actions.
- list_table_primary_column() : string
- Set list table primary column.
- maybe_render_blank_state() : mixed
- Show blank slate.
- render_columns() : mixed
- Render individual columns.
- request_query() : array<string|int, mixed>
- Handle any filters.
- restrict_manage_posts() : mixed
- See if we should render search filters or not.
- row_actions() : array<string|int, mixed>
- Set row actions.
- define_hidden_columns() : array<string|int, mixed>
- Define hidden columns.
- get_primary_column() : string
- Define primary column.
- get_row_actions() : array<string|int, mixed>
- Get row actions to show in the list table.
- prepare_row_data() : mixed
- Pre-fetch any data for the row each column has access to it. the_coupon global is there for bw compat.
- query_filters() : array<string|int, mixed>
- Handle any custom filters.
- render_amount_column() : mixed
- Render columm: amount.
- render_blank_state() : mixed
- Render blank state.
- render_coupon_code_column() : mixed
- Render columm: coupon_code.
- render_description_column() : mixed
- Render columm: description.
- render_expiry_date_column() : mixed
- Render columm: expiry_date.
- render_filters() : mixed
- Render any custom filters and search inputs for the list table.
- render_products_column() : mixed
- Render columm: products.
- render_type_column() : mixed
- Render columm: type.
- render_usage_column() : mixed
- Render columm: usage.
- render_usage_limit_column() : mixed
- Render columm: usage_limit.
Properties
$list_table_type
Post type.
protected
string
$list_table_type
= 'shop_coupon'
$object
Object being shown on the row.
protected
object|null
$object
=
ull
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —default_hidden_columns()
Adjust which columns are displayed by default.
public
default_hidden_columns(array<string|int, mixed> $hidden, object $screen) : array<string|int, mixed>
Parameters
- $hidden : array<string|int, mixed>
-
Current hidden columns.
- $screen : object
-
Current screen.
Return values
array<string|int, mixed> —define_bulk_actions()
Define bulk actions.
public
define_bulk_actions(array<string|int, mixed> $actions) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Existing actions.
Return values
array<string|int, mixed> —define_columns()
Define which columns to show on this screen.
public
define_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
Existing columns.
Return values
array<string|int, mixed> —define_sortable_columns()
Define which columns are sortable.
public
define_sortable_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
Existing columns.
Return values
array<string|int, mixed> —disable_view_mode()
Removes this type from list of post types that support "View Mode" switching.
public
disable_view_mode(array<string|int, mixed> $post_types) : array<string|int, mixed>
View mode is seen on posts where you can switch between list or excerpt. Our post types don't support it, so we want to hide the useless UI from the screen options tab.
Parameters
- $post_types : array<string|int, mixed>
-
Array of post types supporting view mode.
Return values
array<string|int, mixed> — Array of post types supporting view mode, without this type.handle_bulk_actions()
Handle bulk actions.
public
handle_bulk_actions(string $redirect_to, string $action, array<string|int, mixed> $ids) : string
Parameters
- $redirect_to : string
-
URL to redirect to.
- $action : string
-
Action name.
- $ids : array<string|int, mixed>
-
List of ids.
Return values
string —list_table_primary_column()
Set list table primary column.
public
list_table_primary_column(string $default, string $screen_id) : string
Parameters
- $default : string
-
Default value.
- $screen_id : string
-
Current screen ID.
Return values
string —maybe_render_blank_state()
Show blank slate.
public
maybe_render_blank_state(string $which) : mixed
Parameters
- $which : string
-
String which tablenav is being shown.
Return values
mixed —render_columns()
Render individual columns.
public
render_columns(string $column, int $post_id) : mixed
Parameters
- $column : string
-
Column ID to render.
- $post_id : int
-
Post ID being shown.
Return values
mixed —request_query()
Handle any filters.
public
request_query(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
Query vars.
Return values
array<string|int, mixed> —restrict_manage_posts()
See if we should render search filters or not.
public
restrict_manage_posts() : mixed
Return values
mixed —row_actions()
Set row actions.
public
row_actions(array<string|int, mixed> $actions, WP_Post $post) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
array<string|int, mixed> —define_hidden_columns()
Define hidden columns.
protected
define_hidden_columns() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_primary_column()
Define primary column.
protected
get_primary_column() : string
Return values
string —get_row_actions()
Get row actions to show in the list table.
protected
get_row_actions(array<string|int, mixed> $actions, WP_Post $post) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
array<string|int, mixed> —prepare_row_data()
Pre-fetch any data for the row each column has access to it. the_coupon global is there for bw compat.
protected
prepare_row_data(int $post_id) : mixed
Parameters
- $post_id : int
-
Post ID being shown.
Return values
mixed —query_filters()
Handle any custom filters.
protected
query_filters(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
Query vars.
Return values
array<string|int, mixed> —render_amount_column()
Render columm: amount.
protected
render_amount_column() : mixed
Return values
mixed —render_blank_state()
Render blank state.
protected
render_blank_state() : mixed
Return values
mixed —render_coupon_code_column()
Render columm: coupon_code.
protected
render_coupon_code_column() : mixed
Return values
mixed —render_description_column()
Render columm: description.
protected
render_description_column() : mixed
Return values
mixed —render_expiry_date_column()
Render columm: expiry_date.
protected
render_expiry_date_column() : mixed
Return values
mixed —render_filters()
Render any custom filters and search inputs for the list table.
protected
render_filters() : mixed
Return values
mixed —render_products_column()
Render columm: products.
protected
render_products_column() : mixed
Return values
mixed —render_type_column()
Render columm: type.
protected
render_type_column() : mixed
Return values
mixed —render_usage_column()
Render columm: usage.
protected
render_usage_column() : mixed
Return values
mixed —render_usage_limit_column()
Render columm: usage_limit.
protected
render_usage_limit_column() : mixed