Přejít k obsahu

Cron

Systém cron umožňuje definovat naplánované úlohy, které se spouštějí na pozadí v pravidelných intervalech. Přidejte do adresáře bloku soubor cron.php a Blockstudio zaregistruje úlohy pomocí WordPress Cron a spravuje jejich životní cyklus. Samostatné instalace pluginu své úlohy při deaktivaci odstraní. Instalace Composer přibalené k šabloně nebo jinému pluginu vyžadují úklid na straně hostitele nebo wp bs teardown před deaktivací, přepnutím či odstraněním hostitele.

Tím se doplňuje vzor bloku pro celý zásobník: blok může mít UI (index.twig), logiku na serveru (rpc.php), trvalá data (db.php) a nyní také zpracování na pozadí (cron.php).

Jak to funguje

  1. Vytvoříte cron.php v adresáři bloku
  2. Vrátí asociativní pole pojmenovaných úloh
  3. Při každém načtení stránky Blockstudio kontroluje, zda jsou úlohy naplánované
  4. Chybějící naplánované úlohy se zaregistrují pomocí wp_schedule_event()
  5. WordPress Cron spouští callbacky v určeném intervalu
  6. Při deaktivaci samostatného pluginu Blockstudio se všechny události Blockstudio cron odplánují; přibalené instalace využívají níže uvedené postupy úklidu
Kód
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Definice úloh

Vraťte asociativní pole úloh. Každá úloha může být přímým zpětným voláním (výchozí hodnota je daily) nebo polem 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());
    },
];

Definice nativní pro PHP

cron.php může také vrátit objekt s metodami opatřenými atributy. Tím získáte přehlednější rozhraní přirozené pro PHP, přičemž stávající syntaxe pole zůstane zachována.

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 metod se ve výchozím nastavení převádějí na malá písmena a zápis snake_case, takže cleanupOldEntries() se změní na cleanup_old_entries. Pokud chcete výslovně určit název úlohy, použijte name:.

Plány

Vestavěné

WordPress nabízí tyto plány ihned po instalaci:

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

Vlastní intervaly

Zaregistrujte vlastní intervaly pomocí filtru WordPress cron_schedules a poté na ně odkazujte 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 () { /* ... */ },
    ],
];

Běžné vzory

Údržba dat

Odstraňujte staré záznamy, ukončujte zkušební období a archivujte neaktivní 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']);
                }
            }
        },
    ],
];

Synchronizace s externím API

Plánovaně načítejte data ze služeb třetích stran:

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

Oznámení a souhrny

Odesílejte pravidelné zprávy nebo e-maily s oznámeními:

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

Deaktivace

Když je Blockstudio nainstalován jako samostatný plugin, jeho deaktivace automaticky odplánuje všechny události Blockstudio cron.

Instalace Composer uvnitř šablony nebo jiného pluginu nemá vlastní hook pro deaktivaci. Deaktivace hostitelského pluginu, přepnutí na jinou šablonu nebo odstranění přibaleného kódu ponechá události naplánované, pokud hostitel neprovede úklid. Před kteroukoli z těchto akcí spusťte příkaz pro odstranění předem:

Shell
wp bs teardown

Zruší plánování všech událostí Blockstudio cron a odstraní statický stav předvykreslení, který instalace vlastní. Podrobnosti najdete v CLI.

Příkaz je dostupný pouze tehdy, když je Blockstudio stále načten. Hostitelský plugin může místo toho zaregistrovat úklid ve svém hlavním souboru pluginu:

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

Motiv s bundlováním může používat stejné zpětné volání na switch_theme. Zaregistrujte ho, dokud je načtený starý motiv, ne až při hooku after_switch_theme nového motivu:

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

Cron::unschedule_all() odstraní všechny události Blockstudio cron, nejen úlohy z jednoho bloku nebo hostitele. Tyto hooky neodstraní statický stav předgenerovaného výstupu; při vyřazení celé instalace použijte wp bs teardown. Bez úklidu zůstávají opakované události v WordPress a mohou se znovu spustit, pokud se kód jejich bloku znovu nainstaluje.

Filtr

Programově upravte nebo zakažte úlohy:

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

Ladění

WordPress Cron se spouští při návštěvě stránky, nikoli pomocí plánovače na úrovni systému. Na webech s nízkou návštěvností se úlohy nemusí spouštět přesně podle plánu. Pro spolehlivé načasování nastavte skutečný systémový cron, který bude volat wp-cron.php:

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

Poté zakažte vestavěný spouštěč cron v wp-config.php nástroje WordPress:

PHP
define('DISABLE_WP_CRON', true);

Naplánované události zkontrolujete pomocí WP-CLI:

Shell
wp cron event list | grep blockstudio