ActionScheduler_AdminView
extends ActionScheduler_AdminView_Deprecated
in package
Class ActionScheduler_AdminView
Tags
Table of Contents
- $admin_view : mixed
- action_scheduler_post_type_args() : mixed
- admin_notices() : string
- Convert an interval of seconds into a two part human friendly string.
- bulk_actions() : array<string|int, mixed>
- Do not include the "Edit" action for the Scheduled Actions administration screen.
- custom_orderby() : string
- Filter search queries to allow searching by Claim ID (i.e. post_password).
- init() : mixed
- instance() : ActionScheduler_QueueRunner
- list_table_column_content() : mixed
- Print the content for our custom columns.
- list_table_columns() : array<string|int, mixed>
- Completely customer the columns displayed on the Scheduled Actions administration screen.
- list_table_sortable_columns() : array<string|int, mixed>
- Make our custom title & date columns use defaulting title & date sorting.
- list_table_views() : array<string|int, mixed>
- Customise the post status related views displayed on the Scheduled Actions administration screen.
- maybe_execute_action() : mixed
- Run an action when triggered from the Action Scheduler administration screen.
- post_updated_messages() : array<string|int, mixed>
- Change messages when a scheduled action is updated.
- register_menu() : mixed
- Include Action Scheduler's administration under the Tools menu.
- register_system_status_tab() : array<string|int, mixed>
- Registers action-scheduler into WooCommerce > System status.
- render_admin_ui() : mixed
- Renders the Admin UI
- row_actions() : array<string|int, mixed>
- Hide the inline "Edit" action for all 'scheduled-action' posts.
- search_post_password() : string
- Filter search queries to allow searching by Claim ID (i.e. post_password).
- system_status_report() : mixed
Properties
$admin_view
private
static mixed
$admin_view
= NULL
Methods
action_scheduler_post_type_args()
public
action_scheduler_post_type_args(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —admin_notices()
Convert an interval of seconds into a two part human friendly string.
public
static admin_notices() : string
The WordPress human_time_diff() function only calculates the time difference to one degree, meaning even if an action is 1 day and 11 hours away, it will display "1 day". This funciton goes one step further to display two degrees of accuracy.
Based on Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/
Return values
string —A human friendly string representation of the interval.
bulk_actions()
Do not include the "Edit" action for the Scheduled Actions administration screen.
public
bulk_actions(array<string|int, mixed> $actions) : array<string|int, mixed>
Hooked to the 'bulk_actions-edit-action-scheduler' filter.
Parameters
- $actions : array<string|int, mixed>
-
An associative array of actions which can be performed on the 'scheduled-action' post type.
Return values
array<string|int, mixed> —$actions An associative array of actions which can be performed on the 'scheduled-action' post type.
custom_orderby()
Filter search queries to allow searching by Claim ID (i.e. post_password).
public
custom_orderby(string $orderby, WP_Query $query) : string
Parameters
- $orderby : string
-
MySQL orderby string.
- $query : WP_Query
-
Instance of a WP_Query object
Return values
string —MySQL orderby string.
init()
public
init() : mixed
Tags
Return values
mixed —instance()
public
static instance() : ActionScheduler_QueueRunner
Tags
Return values
ActionScheduler_QueueRunner —list_table_column_content()
Print the content for our custom columns.
public
static list_table_column_content(string $column_name, int $post_id) : mixed
Parameters
- $column_name : string
-
The key for the column for which we should output our content.
- $post_id : int
-
The ID of the 'scheduled-action' post for which this row relates.
Return values
mixed —list_table_columns()
Completely customer the columns displayed on the Scheduled Actions administration screen.
public
list_table_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Because we can't filter the content of the default title and date columns, we need to recreate our own custom columns for displaying those post fields. For the column content, @see self::list_table_column_content().
Parameters
- $columns : array<string|int, mixed>
-
An associative array of columns that are use for the table on the Scheduled Actions administration screen.
Return values
array<string|int, mixed> —$columns An associative array of columns that are use for the table on the Scheduled Actions administration screen.
list_table_sortable_columns()
Make our custom title & date columns use defaulting title & date sorting.
public
static list_table_sortable_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen.
Return values
array<string|int, mixed> —$columns An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen.
list_table_views()
Customise the post status related views displayed on the Scheduled Actions administration screen.
public
list_table_views(array<string|int, mixed> $views) : array<string|int, mixed>
Parameters
- $views : array<string|int, mixed>
-
An associative array of views and view labels which can be used to filter the 'scheduled-action' posts displayed on the Scheduled Actions administration screen.
Return values
array<string|int, mixed> —$views An associative array of views and view labels which can be used to filter the 'scheduled-action' posts displayed on the Scheduled Actions administration screen.
maybe_execute_action()
Run an action when triggered from the Action Scheduler administration screen.
public
static maybe_execute_action() : mixed
Tags
Return values
mixed —post_updated_messages()
Change messages when a scheduled action is updated.
public
post_updated_messages(array<string|int, mixed> $messages) : array<string|int, mixed>
Parameters
- $messages : array<string|int, mixed>
Return values
array<string|int, mixed> —register_menu()
Include Action Scheduler's administration under the Tools menu.
public
register_menu() : mixed
A menu under the Tools menu is important for backward compatibility (as that's where it started), and also provides more convenient access than the WooCommerce System Status page, and for sites where WooCommerce isn't active.
Return values
mixed —register_system_status_tab()
Registers action-scheduler into WooCommerce > System status.
public
register_system_status_tab(array<string|int, mixed> $tabs) : array<string|int, mixed>
Parameters
- $tabs : array<string|int, mixed>
-
An associative array of tab key => label.
Return values
array<string|int, mixed> —$tabs An associative array of tab key => label, including Action Scheduler's tabs
render_admin_ui()
Renders the Admin UI
public
render_admin_ui() : mixed
Return values
mixed —row_actions()
Hide the inline "Edit" action for all 'scheduled-action' posts.
public
static row_actions(array<string|int, mixed> $actions, mixed $post) : array<string|int, mixed>
Hooked to the 'post_row_actions' filter.
Parameters
- $actions : array<string|int, mixed>
-
An associative array of actions which can be performed on the 'scheduled-action' post type.
- $post : mixed
Return values
array<string|int, mixed> —$actions An associative array of actions which can be performed on the 'scheduled-action' post type.
search_post_password()
Filter search queries to allow searching by Claim ID (i.e. post_password).
public
search_post_password(string $search, WP_Query $query) : string
Parameters
- $search : string
-
MySQL search string.
- $query : WP_Query
-
Instance of a WP_Query object
Return values
string —MySQL search string.
system_status_report()
public
system_status_report() : mixed