Hoppa till innehåll

Cron

Systemet cron låter dig definiera schemalagda uppgifter som körs i bakgrunden med återkommande intervall. Lägg till en cron.php-fil i din blockkatalog, så registrerar Blockstudio jobben med WordPress Cron och hanterar deras livscykel. Fristående plugininstallationer rensar bort sina jobb vid avaktivering. Composer-installationer som paketerats i ett tema eller ett annat plugin behöver rensas av värden, eller så måste wp bs teardown köras innan värden avaktiveras, byts ut eller tas bort.

Detta är den sista delen i det fullständiga blockmönstret: blocket kan ha en UI (index.twig), serverlogik (rpc.php), beständiga data (db.php) och nu även bakgrundsbearbetning (cron.php).

Så fungerar det

  1. Du skapar cron.php i din blockkatalog
  2. Den returnerar en associativ array med namngivna jobb
  3. Vid varje sidladdning kontrollerar Blockstudio om jobben är schemalagda
  4. Saknade schemaläggningar registreras med wp_schedule_event()
  5. WordPress Cron kör återanropen med det angivna intervallet
  6. När ett fristående Blockstudio-plugin avaktiveras avschemaläggs alla Blockstudio cron-händelser. Paketerade installationer använder rensningsvägarna nedan
Kod
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Definiera jobb

Returnera en associativ array med jobb. Varje jobb kan vara ett direkt återanrop (standard är daily) eller en array med schedule och 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());
    },
];

Definitioner för PHP

cron.php kan också returnera ett objekt med metoder med attribut. Det ger ett renare PHP-inbyggt gränssnitt, samtidigt som den befintliga array-syntaxen bevaras.

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

Metodnamn normaliseras som standard till gemener med snake_case, så cleanupOldEntries() blir cleanup_old_entries. Använd name: när du vill ange ett uttryckligt jobbnamn.

Scheman

Inbyggda

WordPress tillhandahåller följande scheman direkt:

Schema Intervall
hourly Varje timme
twicedaily Var 12:e timme
daily Var 24:e timme
weekly Var 7:e dag

Anpassade intervall

Registrera anpassade intervall via filtret WordPress cron_schedules och referera sedan till dem i 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 () { /* ... */ },
    ],
];

Vanliga mönster

Dataunderhåll

Rensa gamla poster, låt provperioder löpa ut och arkivera inaktiva poster:

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

Synkronisering av extern API

Hämta data från tredjepartstjänster enligt ett schema:

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

Aviseringar och sammanfattningar

Skicka regelbundna rapporter eller e-postaviseringar:

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

Inaktivering

När Blockstudio installeras som ett eget plugin avschemaläggs alla Blockstudio cron-händelser automatiskt när pluginet avaktiveras.

En Composer-installation i ett tema eller ett annat plugin har ingen egen avaktiveringshook. Om värdpluginet avaktiveras, värdtemat byts ut eller den paketerade koden tas bort finns händelserna kvar schemalagda, såvida inte värden rensar bort dem. Kör avvecklingskommandot innan du gör något av detta:

Shell
wp bs teardown

Det avschemalägger varje Blockstudio cron-händelse och tar bort det statiska förrenderingstillstånd som installationen äger. Se CLISe detaljer för mer information.

Kommandot är endast tillgängligt medan Blockstudio fortfarande är laddat. Ett värdplugin kan i stället registrera rensning från sin huvudfil för pluginet:

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

Ett paketerat tema kan använda samma återanrop på switch_theme. Registrera det medan det gamla temat är laddat, inte i hooken after_switch_theme för nästa tema:

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

Cron::unschedule_all() tar bort alla Blockstudio cron-händelser, inte bara jobb från ett block eller en värd. Dessa hookar tar inte bort statiskt förgenererat tillstånd. Använd wp bs teardown när du avvecklar hela installationen. Utan rensning ligger återkommande händelser kvar i WordPress och kan återupptas om blockkoden installeras igen.

Filter

Ändra eller inaktivera jobb programmatiskt:

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

Felsökning

WordPress Cron utlöses av sidbesök, inte av en schemaläggare på systemnivå. På webbplatser med låg trafik kanske jobben inte körs exakt enligt schemat. För tillförlitlig tidsstyrning konfigurerar du ett riktigt system-cron som anropar wp-cron.php:

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

Inaktivera sedan den inbyggda cron-utlösaren för WordPress i wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Kontrollera schemalagda händelser med WP-CLI:

Shell
wp cron event list | grep blockstudio