Ga naar de inhoud

Cron

Met het cron-systeem kunt u geplande taken definiëren die op terugkerende intervallen op de achtergrond worden uitgevoerd. Voeg een cron.php-bestand toe aan uw blockdirectory en Blockstudio registreert de taken bij WordPress Cron en beheert hun levenscyclus. Op zichzelf staande plug-ininstallaties ruimen hun taken op wanneer de plug-in wordt gedeactiveerd. Bij Composer-installaties die zijn opgenomen in een thema of een andere plug-in is opschoning door de host nodig, of wp bs teardown voordat de host wordt gedeactiveerd, vervangen of verwijderd.

Dit is het laatste onderdeel van het full-stack-blokpatroon: uw blok kan een UI (index.twig), serverlogica (rpc.php), persistente gegevens (db.php) en nu ook achtergrondverwerking (cron.php) bevatten.

Werking

  1. U maakt cron.php in uw blockdirectory
  2. Deze retourneert een associatieve array met benoemde taken
  3. Bij elke paginalading controleert Blockstudio of de taken zijn ingepland
  4. Ontbrekende planningen worden geregistreerd met wp_schedule_event()
  5. WordPress Cron voert de callbacks uit met het gedefinieerde interval
  6. Bij de deactivering van een op zichzelf staande Blockstudio-plug-in worden alle Blockstudio cron-gebeurtenissen uit de planning verwijderd; gebundelde installaties gebruiken de onderstaande opschoningsmethoden
Code
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Taken definiëren

Retourneer een associatieve array met taken. Elke taak kan een directe callback zijn (standaard daily) of een array met schedule en 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-native definities

cron.php kan ook een object met toegeschreven methoden retourneren. Zo krijgt u een overzichtelijkere PHP-native interface, terwijl de bestaande arraysyntaxis intact blijft.

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

Methodenamen worden standaard omgezet naar kleine letters met snake_case, dus cleanupOldEntries() wordt cleanup_old_entries. Gebruik name: wanneer u een expliciete taaknaam wilt.

Planningen

Ingebouwd

WordPress biedt standaard de volgende planningen:

Planning Interval
hourly Elk uur
twicedaily Elke 12 uur
daily Elke 24 uur
weekly Elke 7 dagen

Aangepaste intervallen

Registreer aangepaste intervallen via het filter WordPress cron_schedules en verwijs er vervolgens naar in 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 () { /* ... */ },
    ],
];

Veelgebruikte patronen

Gegevensonderhoud

Ruim oude records op, laat proefperiodes verlopen en archiveer inactieve vermeldingen:

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

Synchronisatie met externe API

Haal volgens een planning gegevens op van externe services:

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

Meldingen en samenvattingen

Verstuur periodieke rapporten of meldingsmails:

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

Deactiveren

Wanneer Blockstudio als zelfstandige plug-in is geïnstalleerd, worden bij deactivering van die plug-in automatisch alle Blockstudio cron-gebeurtenissen uit de planning verwijderd.

Een Composer-installatie in een thema of een andere plug-in heeft zelf geen deactiveringshook. Als de hostplug-in wordt gedeactiveerd, het hostthema wordt vervangen of de gebundelde code wordt verwijderd, blijven gebeurtenissen ingepland tenzij de host ze opruimt. Voer de teardownopdracht uit voordat u een van deze handelingen uitvoert:

Shell
wp bs teardown

Hiermee wordt elke gebeurtenis van Blockstudio cron uit de planning verwijderd en de statische prerender-status die de installatie beheert gewist. Zie CLI voor meer informatie.

De opdracht is alleen beschikbaar zolang Blockstudio nog is geladen. Een hostplug-in kan de opschoning ook registreren vanuit het hoofdbestand van de plug-in:

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

Een bundelthema kan dezelfde callback gebruiken op switch_theme. Registreer deze terwijl het oude thema is geladen, niet op de after_switch_theme-hook van het volgende thema:

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

Cron::unschedule_all() verwijdert alle Blockstudio cron-gebeurtenissen, niet alleen de taken van één block of host. Deze hooks verwijderen geen statische prerenderstatus; gebruik wp bs teardown wanneer u de volledige installatie buiten gebruik stelt. Zonder opschoning blijven terugkerende gebeurtenissen in WordPress staan en kunnen ze worden hervat als de blockcode opnieuw wordt geïnstalleerd.

Filter

Taken programmatisch aanpassen of uitschakelen:

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

Foutopsporing

WordPress Cron wordt geactiveerd door paginabezoeken, niet door een systeemplanner. Op sites met weinig verkeer worden taken mogelijk niet precies volgens schema uitgevoerd. Stel voor betrouwbare timing een echte systeem-cron in die wp-cron.php aanroept:

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

Schakel vervolgens de ingebouwde cron-trigger van WordPress uit in wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Gebruik WP-CLI om geplande gebeurtenissen te controleren:

Shell
wp cron event list | grep blockstudio