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
- Adjust which columns are displayed by default.
- define_bulk_actions() : array
- Define bulk actions.
- define_columns() : array
- Define which columns to show on this screen.
- define_sortable_columns() : array
- Define which columns are sortable.
- disable_view_mode() : array
- 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
- Handle any filters.
- restrict_manage_posts() : mixed
- See if we should render search filters or not.
- row_actions() : array
- Set row actions.
- define_hidden_columns() : array
- Define hidden columns.
- get_primary_column() : string
- Define primary column.
- get_row_actions() : array
- 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
- 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
mixeddefault_hidden_columns()
Adjust which columns are displayed by default.
public
default_hidden_columns(array $hidden, object $screen) : array
Parameters
- $hidden : array
-
Current hidden columns.
- $screen : object
-
Current screen.
Return values
arraydefine_bulk_actions()
Define bulk actions.
public
define_bulk_actions(array $actions) : array
Parameters
- $actions : array
-
Existing actions.
Return values
arraydefine_columns()
Define which columns to show on this screen.
public
define_columns(array $columns) : array
Parameters
- $columns : array
-
Existing columns.
Return values
arraydefine_sortable_columns()
Define which columns are sortable.
public
define_sortable_columns(array $columns) : array
Parameters
- $columns : array
-
Existing columns.
Return values
arraydisable_view_mode()
Removes this type from list of post types that support "View Mode" switching.
public
disable_view_mode(array $post_types) : array
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
-
Array of post types supporting view mode.
Return values
array — 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 $ids) : string
Parameters
- $redirect_to : string
-
URL to redirect to.
- $action : string
-
Action name.
- $ids : array
-
List of ids.
Return values
stringlist_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
stringmaybe_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
mixedrender_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
mixedrequest_query()
Handle any filters.
public
request_query(array $query_vars) : array
Parameters
- $query_vars : array
-
Query vars.
Return values
arrayrestrict_manage_posts()
See if we should render search filters or not.
public
restrict_manage_posts() : mixed
Return values
mixedrow_actions()
Set row actions.
public
row_actions(array $actions, WP_Post $post) : array
Parameters
- $actions : array
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
arraydefine_hidden_columns()
Define hidden columns.
protected
define_hidden_columns() : array
Return values
arrayget_primary_column()
Define primary column.
protected
get_primary_column() : string
Return values
stringget_row_actions()
Get row actions to show in the list table.
protected
get_row_actions(array $actions, WP_Post $post) : array
Parameters
- $actions : array
-
Array of actions.
- $post : WP_Post
-
Current post object.
Return values
arrayprepare_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
mixedquery_filters()
Handle any custom filters.
protected
query_filters(array $query_vars) : array
Parameters
- $query_vars : array
-
Query vars.
Return values
arrayrender_amount_column()
Render columm: amount.
protected
render_amount_column() : mixed
Return values
mixedrender_blank_state()
Render blank state.
protected
render_blank_state() : mixed
Return values
mixedrender_coupon_code_column()
Render columm: coupon_code.
protected
render_coupon_code_column() : mixed
Return values
mixedrender_description_column()
Render columm: description.
protected
render_description_column() : mixed
Return values
mixedrender_expiry_date_column()
Render columm: expiry_date.
protected
render_expiry_date_column() : mixed
Return values
mixedrender_filters()
Render any custom filters and search inputs for the list table.
protected
render_filters() : mixed
Return values
mixedrender_products_column()
Render columm: products.
protected
render_products_column() : mixed
Return values
mixedrender_type_column()
Render columm: type.
protected
render_type_column() : mixed
Return values
mixedrender_usage_column()
Render columm: usage.
protected
render_usage_column() : mixed
Return values
mixedrender_usage_limit_column()
Render columm: usage_limit.
protected
render_usage_limit_column() : mixed