当前浏览:首页 / WordPress函数 / wp_get_schedules()

wp_get_schedules()

检索计划任务支持的事件

schedule 计划任务


描述

默认支持的重复出现是“hourly”(每小时)、“twicedaily”(每天两次)、“daily”(每天)和“weekly”(每周)。插件可以通过挂接‘cron_schedules’过滤器添加更多内容。过滤器接受一组数组。外部数组有一个键,该键是计划的名称,例如“monthly”(每月)。该值是一个包含两个键的数组,一个键是“interval”(间隔),另一个键为“display”(显示)。

“interval”是cron计划任务应该运行的秒数。因此,“hourly”的时间为HOUR_IN_SECONDS(60或3600)。对于“monthly”,该值为MONTH_IN_SECONDS(30、24、60或2592000)。

“display”是描述。对于“monthly”键,“display”将为__( 'Once Monthly' )

对于您的插件,将向您传递一个数组。您可以通过执行以下操作轻松添加日程安排。

// Filter parameter variable name is 'array'.
$array['monthly'] = array(
    'interval' => MONTH_IN_SECONDS,
    'display'  => __( 'Once Monthly' )
);

返回

(array[])


更多信息

返回值示例:

Array
(
   [hourly] => Array
       (
           [interval] => 3600
           [display] => Once Hourly
       )
   [twicedaily] => Array
       (
           [interval] => 43200
           [display] => Twice Daily
       )
   [daily] => Array
       (
           [interval] => 86400
           [display] => Once Daily
       )
)


源码

查看源码 官方文档


更新日志

版本描述
5.4.0添加了'weekly'计划。
2.1.0开始引入

使用示例

  • 示例1

    基本示例
    “display”是描述。对于“weekly”键,“display”为:

    __( 'Once Weekly' );
    

    对于您的插件,将向您传递一个数组。通过使用‘cron_schedules’过滤器执行以下操作,可以轻松添加新的间隔计划。

     add_filter( 'cron_schedules', 'cron_add_weekly' );
     
     function cron_add_weekly( $schedules ) {
     	// Adds once weekly to the existing schedules.
     	$schedules['weekly'] = array(
     		'interval' => 604800,
     		'display' => __( 'Once Weekly' )
     	);
     	return $schedules;
     }