当前浏览:首页 / WordPress钩子 / pre_schedule_event

apply_filters( 'pre_schedule_event', null|bool|WP_Error $pre, stdClass $event, bool $wp_error )

过滤以预检或劫持计划任务事件

event

premore...

schedule 计划任务


描述

返回非空值将短路将事件添加到cron数组的过程,导致该函数返回过滤后的值。

单个事件和重复事件都通过此过滤器,单个事件的$event->schedule设置为false,而重复事件设置为来自wp_get_schedules()的重复。重复事件的整数重复间隔也设置为$event->interval

对于替换wp-cron的插件,建议您在十分钟内检查一个相同的事件,并在计划之前应用‘schedule_event’过滤器检查另一个插件是否禁用了该事件。

如果事件已计划,则返回true;如果没有,则返回false或WP_Error


参数

$prenull|bool|WP_Error
要返回的值。默认为null以继续添加事件。
$eventstdClass
包含事件数据的对象.

  • hook string
    事件运行时要执行的动作钩子。
  • timestamp int
    下次运行事件的时间戳(UTC)。
  • schedule string|false
    事件随后应重复发生的频率。
  • args array
    数组,包含传递给钩子回调函数的每个单独参数。
  • interval int
    计划的间隔时间(秒)。仅适用于定期事件。
$wp_errorbool
失败时是否返回WP_Error


源码

查看源码 官方文档


更新日志

版本描述
5.7.0添加了$wp_error参数,现在可以返回WP_Error对象。
5.1.0开始引入