wpseek.com
A WordPress-centric search engine for devs and theme authors
wp_get_schedules › WordPress Function
Since2.1.0
Deprecatedn/a
› wp_get_schedules ( No parameters )
| Returns: |
|
| Defined at: |
|
| Codex: | |
| Change Log: |
|
Retrieves supported event recurrence schedules.
The default supported recurrences are 'hourly', 'twicedaily', 'daily', and 'weekly'. A plugin may add more by hooking into the {@see 'cron_schedules'} filter. The filter accepts an array of arrays. The outer array has a key that is the name of the schedule, for example 'monthly'. The value is an array with two keys, one is 'interval' and the other is 'display'. The 'interval' is a number in seconds of when the cron job should run. So for 'hourly' the time isHOUR_IN_SECONDS (60 * 60 or 3600). For 'monthly',
the value would be MONTH_IN_SECONDS (30 * 24 * 60 * 60 or 2592000).
The 'display' is the description. For the 'monthly' key, the 'display'
would be __( 'Once Monthly' ).
For your plugin, you will be passed an array. You can add your
schedule by doing the following:
// Filter parameter variable name is 'array'.
$array['monthly'] = array(
'interval' => MONTH_IN_SECONDS,
'display' => __( 'Once Monthly' )
);Related Functions: wp_get_schedule, wp_next_scheduled, wp_get_scheduled_event, wp_get_themes, wp_get_sites
Source
function wp_get_schedules() {
$schedules = array(
'hourly' => array(
'interval' => HOUR_IN_SECONDS,
'display' => __( 'Once Hourly' ),
),
'twicedaily' => array(
'interval' => 12 * HOUR_IN_SECONDS,
'display' => __( 'Twice Daily' ),
),
'daily' => array(
'interval' => DAY_IN_SECONDS,
'display' => __( 'Once Daily' ),
),
'weekly' => array(
'interval' => WEEK_IN_SECONDS,
'display' => __( 'Once Weekly' ),
),
);
/**
* Filters the non-default cron schedules.
*
* @since 2.1.0
*
* @param array $new_schedules {
* An array of non-default cron schedules keyed by the schedule name. Default empty array.
*
* @type array ...$0 {
* Cron schedule information.
*
* @type int $interval The schedule interval in seconds.
* @type string $display The schedule display name.
* }
* }
*/
return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );
}