Kama_Cron
Небольшой класс для удобного добавления крон событий (задач) в WordPress.
Ищем WP-разработчика! Фулл-тайм, удаленка, хорошая зарплата, соц. пакет.
Подробности.
Компания Boosta.
Класс позволяет быстро и удобно создавать cron задачи, чтобы не перепутать ничего, все настройки указываются в параметре при вызове класса, всю рутину по правильной регистрации крон задач и их интервалов класс берет на себя. Функции-обработчики задач нужно писать отдельно!
Код класса Kama_Cron
GitHub<?php
/**
* Convenient way to add cron tasks in WordPress.
*
* Usage Example:
*
* ```
* new Kama_Cron( [
* 'wpkama_cron_func' => [
* 'callback' => 'wpkama_cron_func', // PHP function to run on job
* 'interval_name' => '10_min', // you can set already registered interval: hourly, twicedaily, daily
* 'interval_desc' => 'Every 10 min', // no need if already registered interval is set.
* ],
* ] );
*
* new Kama_Cron( [
* 'single_job' => [
* 'callback' => 'single_job_func',
* 'start_time' => strtotime( '2021-06-05' ),
* ],
* ] );
*
* new Kama_Cron( [
* 'id' => 'my_cron_jobs', // not required param
* 'events' => [
* // first task
* 'wpkama_cron_func' => [
* 'callback' => 'wpkama_cron_func', // PHP function to run on job
* 'interval_name' => '10_min', // you can set already registered interval: hourly, twicedaily, daily
* 'interval_desc' => 'Every 10 min', // no need if already registered interval is set.
* ],
* // second task
* 'wpkama_cron_func_2' => [
* 'callback' => 'wpkama_cron_func_2',
* 'start_time' => time() + DAY_IN_SECONDS, // start in 1 day
* 'interval_name' => 'two_hours',
* 'interval_sec' => HOUR_IN_SECONDS * 2,
* 'interval_desc' => 'Every 2 hours',
* ],
* // third task
* 'wpkama_cron_func_3' => [
* 'callback' => 'wpkama_cron_func_3',
* 'interval_name' => 'hourly', // this is already a known WP interval
* ],
* ],
* ] );
* ```
*
* @changelog: https://github.com/doiftrue/Kama_Cron/blob/master/changelog.md
*
* @author Kama (wp-kama.com)
*
* @version 0.4.9
*/
class Kama_Cron {
// must be 0 on production.
// For debug go to: http://site.com/wp-cron.php
const DEBUG = false;
/**
* Collects every cron options called with this class. Internal.
*
* @var array
*/
static $opts = [];
/**
* ID for opts (Not uses for cron). Internal.
*
* @var string
*/
protected $id;
/**
* Constructor.
*
* @param array $args {
* Args.
*
* @type string $id A unique identifier that can then be used to access the settings.
* Default: keys of the $events parameter.
* @type bool $auto_activate true - automatically creates the specified event when visiting the admin panel.
* In this case, you do not need to call the activate() method separately.
* @type array $events {
* An array of events to add to the crown. The element key will be used in the cron hook.
* The element value is an array of event parameters that can contain the following keys:
*
* @type callable $callback The name of the crown task function.
* @type mixed $args What parameters should be passed to the crown task function.
* @type string $interval_name The name of the interval, for example: 'half_an_hover'.
* You can specify the name in the following format:
* `N_(min|hour|day|month)` — 10_min, 2_hours, 5_days, 2_month,
* then the number will be taken as interval time.
* You can specify an existing WP interval: hourly, twicedaily, daily,
* then the interval time should not be set.
* Omite this parameter to register single cron job.
* @type int $interval_sec Interval time, for example HOUR_IN_SECONDS / 2.
* You don't need to specify this papameter when $interval_name one of:
* N_(min|hour|day|month), hourly, twicedaily, daily.
* @type string $interval_desc Description of the interval, for example, 'Every half hour'.
* You don't need to specify this param when $interval_name one of:
* hourly, twicedaily, daily.
* @type int $start_time UNIX timestamp. When to start the event. By default: time().
* }
*
* }
*/
public function __construct( $args ){
if( empty( $args['events'] ) ){
$args = [ 'events' => $args ];
}
$args_def = [
'id' => implode( '--', array_keys( $args['events'] ) ),
'auto_activate' => true,
'events' => [
'hook_name' => [
'callback' => [ __CLASS__, 'default_callback' ],
'args' => [],
'interval_name' => '',
'interval_sec' => 0,
'interval_desc' => '',
'start_time' => 0,
],
],
];
$event_def = $args_def['events']['hook_name'];
unset( $args_def['events'] );
// complete parameters using defaults
$args = array_merge( $args_def, $args );
// complete `events` elements
foreach( $args['events'] as & $events ){
$events = array_merge( $event_def, $events );
}
unset( $events );
$rg = (object) $args;
$this->id = $rg->id;
self::$opts[ $this->id ] = $rg;
// after self::$opts
add_filter( 'cron_schedules', [ $this, 'add_intervals' ] );
// after 'cron_schedules'
if( $rg->auto_activate && ( is_admin() || defined( 'WP_CLI' ) || defined( 'DOING_CRON' ) ) ){
self::activate( $this->id );
}
foreach( $rg->events as $hook => $data ){
add_action( $hook, $data['callback'] );
}
if( self::DEBUG && defined( 'DOING_CRON' ) ){
add_action( 'wp_loaded', function(){
echo 'Current time: ' . time() . "\n\n\n" . 'Existing Intervals:' . "\n" .
print_r( wp_get_schedules(), 1 ) . "\n\n\n" . print_r( _get_cron_array(), 1 );
} );
}
}
public function add_intervals( $schedules ){
foreach( self::$opts[ $this->id ]->events as $data ){
$interval_name = $data['interval_name'];
if(
// it is a single event.
! $interval_name
// already exists
|| isset( $schedules[ $interval_name ] )
// internal WP intervals
|| in_array( $interval_name, [ 'hourly', 'twicedaily', 'daily' ] )
){
continue;
}
// allow set only `interval_name` parameter like: 10_min, 2_hours, 5_days, 2_month
if( ! $data['interval_sec'] ){
if( preg_match( '/(\d+)[_-](min|hour|day|month)s?/', $interval_name, $mm ) ){
$min = 60;
$hour = $min * 60;
$day = $hour * 24;
$month = $day * 30;
$data['interval_sec'] = $mm[1] * ${ $mm[2] };
}
else {
/** @noinspection ForgottenDebugOutputInspection */
wp_die( 'ERROR: Kama_Cron required event parameter `interval_sec` not set. ' . print_r( debug_backtrace(), 1 ) );
}
}
$schedules[ $interval_name ] = [
'interval' => $data['interval_sec'],
'display' => $data['interval_desc'],
];
}
return $schedules;
}
/**
* Add cron task.
* Should be called on plugin activation. Can be called somewhere else, for example, when updating the settings.
*
* @param string $id
*/
static function activate( $id = '' ){
$opts = $id ? [ $id => self::$opts[ $id ] ] : self::$opts;
foreach( $opts as $opt ){
foreach( $opt->events as $hook => $data ){
if( wp_next_scheduled( $hook, $data['args'] ) ){
continue;
}
if( $data['interval_name'] ){
wp_schedule_event( $data['start_time'] ?: time(), $data['interval_name'], $hook, $data['args'] );
}
// single event
elseif( ! $data['start_time'] ){
trigger_error( __CLASS__ . ' ERROR: Start time not specified for single event' );
}
elseif( $data['start_time'] > time() ){
wp_schedule_single_event( $data['start_time'], $hook, $data['args'] );
}
}
}
}
/**
* Removes cron task.
* Should be called on plugin deactivation.
*
* @param string $id
*/
static function deactivate( $id = '' ){
$opts = $id ? [ $id => self::$opts[ $id ] ] : self::$opts;
foreach( $opts as $opt ){
foreach( $opt->events as $hook => $data ){
wp_clear_scheduled_hook( $hook, $data['args'] );
}
}
}
static function default_callback(){
echo "ERROR: One of Kama_Cron callback function not set.\n\nKama_Cron::\$opts = " .
print_r( self::$opts, 1 ) . "\n\n\n\n_get_cron_array() =" .
print_r( _get_cron_array(), 1 );
}
}
Примеры использования класса Kama_Cron
Для начала, скопируйте код класса и вставьте его в плагин или functions.php темы.
Вызывать new Kama_Cron() можно на самом раннем этапе загрузки WP, начиная с самого раннего события muplugins_loaded.
ВАЖНО! Код вызова new Kama_Cron() должен срабатывать (вызываться) при крон запросах, так как на нем регистрируются необходимые WP хуки, которые будут отрабатывать при крон запросах. Другими, словами нельзя зарегистрировать крон задачу с помощью этого кода и удалить его.
Пример 1: Простое использование без дополнительных параметров
В этом примере указанная задача Cron будет зарегистрирована автоматически при посещении админ-панели или при любому Cron запросе.
wpkama_cron_hook - это внутреннее имя хука WP, вам не нужно использовать его где-либо в своем коде - просто укажите понятное имя (можно указать название PHP функции).
Используем неизвестный для WP интервал:
new Kama_Cron( [
'wpkama_cron_hook' => [
'callback' => 'wpkama_cron_func', // PHP function to run on job
'interval_name' => '10_min', // you can set already registered interval: hourly, twicedaily, daily
'interval_desc' => 'Every 10 min', // no need if already registered interval is set.
],
] );
function wpkama_cron_func(){
// your code to do the cron job
}
Используем известный WP интервал:
new Kama_Cron( [
'wpkama_core_data_check_update' => [
'callback' => 'wpkama_core_data_check_update',
'interval_name' => 'hourly',
]
] );
function wpkama_core_data_check_update(){
// your code to do the cron job
}
Пример 2: Создадим 3 крон задачи
Создадим 3 крон задачи с разными интервалами. Задачи регистрируются автоматически при посещении админ-панели (это работает очень быстро). Код добавляем куда угодно, например в functions.php.
new Kama_Cron([
'id' => 'my_cron_jobs', // не обязательный параметр
'events' => array(
// первая задача
'wpkama_cron_func' => array(
'callback' => 'wpkama_cron_func', // название функции крон-задачи
'interval_name' => '10_min', // можно указать уже имеющийся интервал: hourly, twicedaily, daily
'interval_desc' => 'Каждые 10 минут', // не нужен, если задан уже имеющийся интервал
),
// вторая задача
'wpkama_cron_func_2' => array(
'callback' => 'wpkama_cron_func_2',
'start_time' => time() + DAY_IN_SECONDS, // начать через 1 день
'interval_name' => 'two_hours',
'interval_sec' => HOUR_IN_SECONDS * 2,
'interval_desc' => 'Каждые 2 часа',
),
// третья задача
'wpkama_cron_func_3' => array(
'callback' => 'wpkama_cron_func_3',
'interval_name' => 'hourly', // это уже известный WP интервал
),
),
]);
//Kama_Cron::$DEBUG = 1; // для дебага
//Kama_Cron::deactivate('my_cron_jobs'); // для удаления
// Функция крона
function wpkama_cron_func(){
file_put_contents( dirname(ABSPATH) .'/cron_check.txt', current_time('mysql') ."\n", FILE_APPEND );
}
// Функция крона
function wpkama_cron_func_2(){
// операции
}
// Функция крона
function wpkama_cron_func_3(){
// операции
}
Пример 3: Регистрация задач при активации плагина
Код ниже показывает, как активировать и деактивировать задачи при активации/деактивации плагина.
// Пример активации и деактивации, если не указан параметр auto_activate
register_activation_hook( __FILE__, function(){
Kama_Cron::activate( 'my_cron_jobs_2' );
} );
register_deactivation_hook( __FILE__, function(){
Kama_Cron::deactivate( 'my_cron_jobs_2' );
} );
new Kama_Cron([
'id' => 'my_cron_jobs_2',
'auto_activate' => false, // false чтобы повесить активацию задач на register_activation_hook()
'events' => array(
// первая задача
'wpkama_cron_func_4' => array(
'callback' => 'wpkama_cron_func_4', // название функции крон-задачи
'interval_name' => 'twicedaily', // можно указать уже имеющийся интервал: hourly, twicedaily, daily
),
// вторая задача
'wpkama_cron_func_5' => array(
'callback' => 'wpkama_cron_func_5',
'interval_name' => 'two_hours',
'interval_sec' => HOUR_IN_SECONDS * 2,
'interval_desc' => 'Каждые 2 часа',
),
),
]);
function wpkama_cron_func_4(){
// операции
}
function wpkama_cron_func_5(){
// операции
}
