Preskočiť na obsah

Cron

Systém cron umožňuje definovať naplánované úlohy, ktoré sa spúšťajú na pozadí v pravidelných intervaloch. Do adresára bloku pridajte súbor cron.php a Blockstudio zaregistruje úlohy pomocou WordPress Cron a spravuje ich životný cyklus. Samostatné inštalácie pluginu pri deaktivácii úlohy odstránia. Inštalácie Composer zabalené v téme alebo inom plugine vyžadujú vyčistenie zo strany hostiteľa alebo wp bs teardown pred deaktiváciou, prepnutím či odstránením hostiteľa.

Toto je posledná časť úplného vzoru bloku: váš blok môže mať UI (index.twig), logiku na serveri (rpc.php), trvalé údaje (db.php) a teraz aj spracovanie na pozadí (cron.php).

Ako to funguje

  1. V adresári bloku vytvoríte cron.php
  2. Vráti asociatívne pole pomenovaných úloh
  3. Pri každom načítaní stránky Blockstudio skontroluje, či sú úlohy naplánované
  4. Chýbajúce naplánované úlohy sa zaregistrujú pomocou wp_schedule_event()
  5. WordPress Cron spúšťa spätné volania v určenom intervale
  6. Pri deaktivácii samostatného pluginu Blockstudio sa všetky udalosti Blockstudio cron zrušia; zabalené inštalácie používajú postupy čistenia uvedené nižšie
Kód
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Definovanie úloh

Vráťte asociatívne pole úloh. Každá úloha môže byť priamym spätným volaním (predvolene daily) alebo poľom s položkami schedule a 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());
    },
];

Definície v štýle PHP

cron.php môže vrátiť aj objekt s metódami. Získate tak prehľadnejšie rozhranie v štýle PHP pri zachovaní existujúcej syntaxe polí.

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
    }
};

Názvy metód sa predvolene normalizujú na malé písmená a formát snake case, takže cleanupOldEntries() sa zmení na cleanup_old_entries. Ak chcete určiť názov úlohy priamo, použite name:.

Plány

Vstavané

WordPress štandardne poskytuje tieto plány:

Plán Interval
hourly Každú hodinu
twicedaily Každých 12 hodín
daily Každých 24 hodín
weekly Každých 7 dní

Vlastné intervaly

Zaregistrujte vlastné intervaly pomocou filtra WordPress cron_schedules a potom na ne odkážte v 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 () { /* ... */ },
    ],
];

Bežné vzory

Údržba údajov

Odstráňte staré záznamy, ukončite skúšobné obdobia a archivujte neaktívne položky:

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']);
                }
            }
        },
    ],
];

Synchronizácia s externým systémom API

Plánovane získavajte údaje zo služieb tretích strán:

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);
                }
            }
        },
    ],
];

Upozornenia a súhrny

Posielajte pravidelné správy alebo e-mailové upozornenia:

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");
        },
    ],
];

Deaktivácia

Keď je Blockstudio nainštalovaný ako samostatný plugin, jeho deaktiváciou sa automaticky zruší naplánovanie všetkých udalostí Blockstudio cron.

Inštalácia Composer v téme alebo inom plugine nemá vlastný hook deaktivácie. Ak hostiteľský plugin deaktivujete, prepnete na inú tému alebo odstránite pribalený kód, udalosti zostanú naplánované, pokiaľ hostiteľ nevykoná čistenie. Pred ktorýmkoľvek z týchto krokov spustite príkaz na odstránenie:

Shell
wp bs teardown

Zruší plánovanie každej udalosti Blockstudio cron a odstráni statický stav predvykreslenia, ktorý vlastní inštalácia. Podrobnosti nájdete v CLI.

Príkaz je dostupný iba dovtedy, kým je Blockstudio načítaný. Hostiteľský plugin môže namiesto toho zaregistrovať čistenie vo svojom hlavnom súbore pluginu:

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

Téma, ktorá obsahuje balík, môže použiť rovnaké spätné volanie pri switch_theme. Zaregistrujte ho, kým je načítaná stará téma, nie v hooku after_switch_theme nasledujúcej témy:

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

Cron::unschedule_all() odstráni všetky udalosti Blockstudio cron, nielen úlohy z jedného bloku alebo hostiteľa. Tieto hooky neodstránia statický stav predgenerovania; pri ukončení celej inštalácie použite wp bs teardown. Bez čistenia zostanú opakované udalosti v WordPress a môžu sa obnoviť, ak sa kód ich bloku znova nainštaluje.

Filter

Úlohy môžete upraviť alebo zakázať programovo:

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;
});

Ladenie

WordPress Cron sa spúšťa pri návšteve stránky, nie pomocou systémového plánovača. Na stránkach s nízkou návštevnosťou sa úlohy nemusia spustiť presne podľa plánu. Ak potrebujete spoľahlivé časovanie, nastavte skutočný systém cron, ktorý bude volať wp-cron.php:

Shell
*/5 * * * * curl -s https://yoursite.com/wp-cron.php > /dev/null 2>&1

Potom v wp-config.php zakážte vstavaný spúšťač cron v WordPress:

PHP
define('DISABLE_WP_CRON', true);

Naplánované udalosti skontrolujete pomocou WP-CLI:

Shell
wp cron event list | grep blockstudio