Properties

$list_table

$list_table : \ActionScheduler_ListTable

ActionScheduler_ListTable instance.

Type

normal

$admin_view

$admin_view : null|self

Instance.

Type

normal

$screen_id

$screen_id : string

Screen ID.

Type

normal

Methods

action_scheduler_post_type_args()

action_scheduler_post_type_args(array  $args) : mixed

Adjust parameters for custom post type.

Parameters

array $args

Args.

Returns

mixed

list_table_views()

list_table_views(array  $views) : array

Customise the post status related views displayed on the Scheduled Actions administration screen.

Parameters

array $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.

Returns

array —

$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.

bulk_actions()

bulk_actions(array  $actions) : array

Do not include the "Edit" action for the Scheduled Actions administration screen.

Hooked to the 'bulk_actions-edit-action-scheduler' filter.

Parameters

array $actions

An associative array of actions which can be performed on the 'scheduled-action' post type.

Returns

array —

$actions An associative array of actions which can be performed on the 'scheduled-action' post type.

list_table_columns()

list_table_columns(array  $columns) : array

Completely customer the columns displayed on the Scheduled Actions administration screen.

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

array $columns

An associative array of columns that are use for the table on the Scheduled Actions administration screen.

Returns

array —

$columns An associative array of columns that are use for the table on the Scheduled Actions administration screen.

list_table_sortable_columns()

list_table_sortable_columns(array  $columns) : array

Make our custom title & date columns use defaulting title & date sorting.

Parameters

array $columns

An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen.

Returns

array —

$columns An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen.

list_table_column_content()

list_table_column_content(string  $column_name, int  $post_id) : mixed

Print the content for our custom columns.

Parameters

string $column_name

The key for the column for which we should output our content.

int $post_id

The ID of the 'scheduled-action' post for which this row relates.

Returns

mixed

row_actions()

row_actions(array  $actions, \WP_Post  $post) : array

Hide the inline "Edit" action for all 'scheduled-action' posts.

Hooked to the 'post_row_actions' filter.

Parameters

array $actions

An associative array of actions which can be performed on the 'scheduled-action' post type.

\WP_Post $post

The 'scheduled-action' post object.

Returns

array —

$actions An associative array of actions which can be performed on the 'scheduled-action' post type.

maybe_execute_action()

maybe_execute_action() : mixed

Run an action when triggered from the Action Scheduler administration screen.

Returns

mixed

admin_notices()

admin_notices() : void

Convert an interval of seconds into a two part human friendly 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 function goes one step further to display two degrees of accuracy.

Based on Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/

custom_orderby()

custom_orderby(string  $orderby, \WP_Query  $query) : void

Filter search queries to allow searching by Claim ID (i.e. post_password).

Parameters

string $orderby

MySQL orderby string.

\WP_Query $query

Instance of a WP_Query object.

search_post_password()

search_post_password(string  $search, \WP_Query  $query) : void

Filter search queries to allow searching by Claim ID (i.e. post_password).

Parameters

string $search

MySQL search string.

\WP_Query $query

Instance of a WP_Query object.

post_updated_messages()

post_updated_messages(array  $messages) : array

Change messages when a scheduled action is updated.

Parameters

array $messages

Messages.

Returns

array

instance()

instance() : \ActionScheduler_AdminView

Get instance.

Returns

\ActionScheduler_AdminView

init()

init() : mixed

Initialize.

Returns

mixed

system_status_report()

system_status_report() : mixed

Print system status report.

Returns

mixed

register_system_status_tab()

register_system_status_tab(array  $tabs) : array

Registers action-scheduler into WooCommerce > System status.

Parameters

array $tabs

An associative array of tab key => label.

Returns

array —

$tabs An associative array of tab key => label, including Action Scheduler's tabs

register_menu()

register_menu() : mixed

Include Action Scheduler's administration under the Tools menu.

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.

Returns

mixed

process_admin_ui()

process_admin_ui() : mixed

Triggers processing of any pending actions.

Returns

mixed

render_admin_ui()

render_admin_ui() : mixed

Renders the Admin UI

Returns

mixed

maybe_check_pastdue_actions()

maybe_check_pastdue_actions() : mixed

Action: admin_notices

Maybe check past-due actions, and print notice.

Returns

mixed

add_help_tabs()

add_help_tabs() : mixed

Provide more information about the screen and its data in the help tab.

Returns

mixed

get_list_table()

get_list_table() : \ActionScheduler_ListTable

Get the admin UI object and process any requested actions.

Returns

\ActionScheduler_ListTable

check_pastdue_actions()

check_pastdue_actions() : mixed

Check past-due actions, and print notice.

Returns

mixed