Към съдържанието

Cron

Системата cron ви позволява да дефинирате планирани задачи, които се изпълняват във фонов режим през повтарящ се интервал. Добавете файл cron.php към директорията на блока си и Blockstudio регистрира задачите чрез WordPress Cron и управлява жизнения им цикъл. При самостоятелни инсталации като плъгин задачите се изчистват при деактивиране. Инсталациите на Composer, включени в тема или друг плъгин, изискват почистване от хост средата или wp bs teardown, преди тя да бъде деактивирана, сменена или премахната.

Това е последният елемент от пълностековия модел за блокове: блокът ви може да има UI (index.twig), сървърна логика (rpc.php), постоянни данни (db.php) и вече — фонови задачи (cron.php).

Как работи

  1. Създавате cron.php в директорията на блока си
  2. То връща асоциативен масив с именувани задачи
  3. При всяко зареждане на страница Blockstudio проверява дали задачите са планирани
  4. Липсващите планирания се регистрират чрез wp_schedule_event()
  5. WordPress Cron изпълнява обратните извиквания през зададения интервал
  6. При деактивиране на самостоятелен плъгин Blockstudio всички събития Blockstudio cron се премахват от графика; при включени инсталации се използват описаните по-долу начини за почистване
Код
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Дефиниране на задачи

Върнете асоциативен масив със задачи. Всяка задача може да бъде директно обратно извикване (по подразбиране daily) или масив с schedule и callback:

PHP
return [
    // Expanded format with custom schedule
    'cleanup' => [
        'schedule' => 'hourly',
        'callback' => function () {
            // runs every hour
        },
    ],

    // Shorthand: just a callback, defaults to daily
    'heartbeat' => function () {
        update_option('my_block_last_heartbeat', time());
    },
];

Дефиниции в стил PHP

cron.php може също да върне обект с методи, зададени чрез атрибути. Така интерфейсът в стил PHP става по-изчистен, като същевременно се запазва съществуващият синтаксис с масиви.

PHP
<?php
use Blockstudio\Attributes\Cron;
use Blockstudio\Cron\Schedule;

return new class {
    #[Cron(schedule: Schedule::Hourly)]
    public function heartbeat(): void {
        update_option('my_block_last_heartbeat', time());
    }

    #[Cron]
    public function cleanupOldEntries(): void {
        // defaults to daily
    }
};

По подразбиране имената на методите се преобразуват в малки букви със snake_case, така че cleanupOldEntries() става cleanup_old_entries. Използвайте name:, когато искате изрично да зададете име на задача.

Разписания

Вградени

WordPress предоставя следните разписания веднага след инсталирането:

Разписание Интервал
hourly На всеки час
twicedaily На всеки 12 часа
daily На всеки 24 часа
weekly На всеки 7 дни

Персонализирани интервали

Регистрирайте персонализирани интервали чрез филтъра WordPress cron_schedules, след което посочете ги в cron.php:

PHP
add_filter('cron_schedules', function ($schedules) {
    $schedules['every_five_minutes'] = [
        'interval' => 300,
        'display'  => 'Every 5 Minutes',
    ];
    $schedules['every_fifteen_minutes'] = [
        'interval' => 900,
        'display'  => 'Every 15 Minutes',
    ];
    return $schedules;
});
PHP
return [
    'check_external_api' => [
        'schedule' => 'every_five_minutes',
        'callback' => function () { /* ... */ },
    ],
];

Често срещани приложения

Поддръжка на данни

Изтривайте стари записи, изтичайте пробни периоди и архивирайте неактивни записи:

PHP
use Blockstudio\Db;

return [
    'expire_trials' => [
        'schedule' => 'daily',
        'callback' => function () {
            $db     = Db::get('my-theme/app', 'subscribers');
            $trials = $db->list(['plan' => 'trial']);

            foreach ($trials as $trial) {
                if (strtotime($trial['created_at']) < strtotime('-14 days')) {
                    $db->update((int) $trial['id'], ['plan' => 'expired']);
                }
            }
        },
    ],
    'purge_old_logs' => [
        'schedule' => 'weekly',
        'callback' => function () {
            $db   = Db::get('my-theme/app', 'activity_log');
            $logs = $db->list();

            foreach ($logs as $log) {
                if (strtotime($log['created_at']) < strtotime('-90 days')) {
                    $db->delete((int) $log['id']);
                }
            }
        },
    ],
];

Синхронизиране с външни API

Извличайте данни от външни услуги по график:

PHP
return [
    'sync_products' => [
        'schedule' => 'hourly',
        'callback' => function () {
            $response = wp_remote_get('https://api.example.com/products');

            if (is_wp_error($response)) {
                return;
            }

            $products = json_decode(wp_remote_retrieve_body($response), true);
            $db       = \Blockstudio\Db::get('my-theme/shop', 'products');

            foreach ($products as $product) {
                $existing = $db->list(['external_id' => $product['id']]);

                if (empty($existing)) {
                    $db->create($product);
                } else {
                    $db->update((int) $existing[0]['id'], $product);
                }
            }
        },
    ],
];

Известия и обобщения

Изпращайте периодични отчети или имейли с известия:

PHP
use Blockstudio\Db;

return [
    'weekly_digest' => [
        'schedule' => 'weekly',
        'callback' => function () {
            $db   = Db::get('my-theme/app', 'subscribers');
            $new  = count($db->list(['status' => 'active']));
            $admin = get_option('admin_email');

            wp_mail($admin, 'Weekly Digest', "Active subscribers: $new");
        },
    ],
];

Деактивиране

Когато Blockstudio е инсталиран като самостоятелен плъгин, деактивирането му автоматично премахва от графика всички събития Blockstudio cron.

Инсталация на Composer, включена в тема или друг плъгин, няма собствена кука за деактивиране. Деактивирането на хост плъгина, смяната на хост темата или премахването на включения код оставя събитията планирани, освен ако хостът не извърши почистване. Изпълнете командата за премахване преди което и да е от тези действия:

Обвивка
wp bs teardown

Тя премахва от разписанието всяко събитие Blockstudio cron и изтрива статичното състояние за предварително изобразяване, собственост на инсталацията. Вижте CLI за подробности.

Командата е налична само докато Blockstudio все още е зареден. Вместо това хост плъгинът може да регистрира почистването в основния си файл:

PHP
register_deactivation_hook(__FILE__, function () {
    if (class_exists(\Blockstudio\Cron::class)) {
        \Blockstudio\Cron::unschedule_all();
    }
});

Тема, която включва пакета, може да използва същото обратно извикване при switch_theme. Регистрирайте го, докато старата тема е заредена, а не при куката after_switch_theme на следващата тема:

PHP
add_action('switch_theme', function () {
    if (class_exists(\Blockstudio\Cron::class)) {
        \Blockstudio\Cron::unschedule_all();
    }
});

Cron::unschedule_all() премахва всички събития Blockstudio cron, а не само задачите от един блок или хост. Тези куки не премахват статичното предварително рендерирано състояние; използвайте wp bs teardown при извеждане от употреба на цялата инсталация. Без почистване повтарящите се събития остават в WordPress и може да се възобновят, ако кодът на блока бъде инсталиран отново.

Филтриране

Променяйте или деактивирайте задачите програмно:

PHP
add_filter('blockstudio/cron', function (array $jobs): array {
    // Disable a specific job
    unset($jobs['my-theme/app']['cleanup']);

    // Change a schedule
    if (isset($jobs['my-theme/app']['sync'])) {
        $jobs['my-theme/app']['sync']['schedule'] = 'twicedaily';
    }

    return $jobs;
});

Отстраняване на грешки

WordPress Cron се задейства при посещения на страницата, а не от системен планировчик. При сайтове с малко трафик задачите може да не се изпълняват точно по график. За надеждно планиране настройте истински системен cron, който да извиква wp-cron.php:

Обвивка
*/5 * * * * curl -s https://yoursite.com/wp-cron.php > /dev/null 2>&1

След това деактивирайте вградения тригер на WordPress за cron в wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

За да проверите планираните събития, използвайте WP-CLI:

Обвивка
wp cron event list | grep blockstudio