Gå til indhold

Cron

Systemet cron lader dig definere planlagte opgaver, der kører i baggrunden med et fast interval. Tilføj en cron.php-fil i din blokmappe, så Blockstudio registrerer opgaverne med WordPress Cron og håndterer deres livscyklus. Selvstændige plugininstallationer rydder op i deres opgaver ved deaktivering. Composer-installationer, der er samlet i et tema eller et andet plugin, kræver oprydning fra værten eller wp bs teardown, før værten deaktiveres, skiftes eller fjernes.

Dette er den sidste del af det fulde stack-blokmønster: din blok kan have en UI (index.twig), serverlogik (rpc.php), vedvarende data (db.php) og nu også baggrundsbehandling (cron.php).

Sådan fungerer det

  1. Du opretter cron.php i din blokmappe
  2. Den returnerer et associativt array med navngivne opgaver
  3. Ved hver sideindlæsning kontrollerer Blockstudio, om opgaverne er planlagt
  4. Manglende planer registreres med wp_schedule_event()
  5. WordPress Cron udløser callbacks med det definerede interval
  6. Når et selvstændigt Blockstudio-plugin deaktiveres, afplanlægges alle Blockstudio cron-hændelser; samlede installationer bruger oprydningsmetoderne nedenfor
Kode
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Definition af opgaver

Returnér et associerende array med opgaver. Hver opgave kan være en direkte callback (standard er daily) eller et array med schedule og 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 definitioner

cron.php kan også returnere et objekt med metoder som attributter. Det giver en renere overflade, der er indbygget i PHP, samtidig med at den eksisterende arraysyntaks bevares.

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

Metodenavne normaliseres som standard til små bogstaver med snake case, så cleanupOldEntries() bliver til cleanup_old_entries. Brug name:, hvis du vil angive et eksplicit opgavenavn.

Tidsplaner

Indbyggede

WordPress indeholder følgende tidsplaner fra start:

Tidsplan Interval
hourly Hver time
twicedaily Hver 12. time
daily Hver 24. time
weekly Hver 7. dag

Brugerdefinerede intervaller

Registrér brugerdefinerede intervaller via filteret WordPress cron_schedules, og referér derefter til 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 () { /* ... */ },
    ],
];

Almindelige mønstre

Datavedligeholdelse

Ryd op i gamle poster, udløb prøveperioder, og arkivér inaktive elementer:

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 af eksterne API

Hent data fra tredjepartstjenester efter en tidsplan:

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

Meddelelser og oversigter

Send periodiske rapporter eller e-mails med meddelelser:

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

Deaktivering

Når Blockstudio er installeret som sit eget plugin, afplanlægger deaktivering af dette plugin automatisk alle Blockstudio cron-hændelser.

En Composer-installation i et tema eller et andet plugin har ikke sin egen deaktiveringshook. Deaktiveres værtspluginet, skiftes der væk fra værtstemaet, eller fjernes den samlede kode, forbliver hændelserne planlagt, medmindre værten rydder op. Kør nedtagningskommandoen før noget af dette:

Shell
wp bs teardown

Den afplanlægger alle Blockstudio cron-hændelser og fjerner den statiske prerender-tilstand, som installationen ejer. Se CLI for detaljer.

Kommandoen er kun tilgængelig, mens Blockstudio stadig er indlæst. Et værtsplugin kan i stedet registrere oprydning fra sin hovedfil:

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

Et samlende tema kan bruge samme callback på switch_theme. Registrer den, mens det gamle tema er indlæst, ikke på det nye temas after_switch_theme-hook:

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

Cron::unschedule_all() fjerner alle Blockstudio cron-hændelser, ikke kun opgaver fra én blok eller vært. Disse hooks fjerner ikke den statiske prerender-tilstand; brug wp bs teardown, når hele installationen udfases. Uden oprydning forbliver tilbagevendende hændelser i WordPress og kan genoptages, hvis blok-koden installeres igen.

Filtrering

Rediger eller deaktiver job programmatisk:

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

Fejlfinding

WordPress Cron udløses af sidebesøg, ikke af en scheduler på systemniveau. På websteder med lav trafik kører job muligvis ikke præcist efter planen. Hvis sikker timing er vigtig, skal du konfigurere en rigtig system-cron, der rammer wp-cron.php:

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

Deaktiver derefter WordPresss indbyggede trigger for cron i wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Brug WP-CLI til at kontrollere planlagte hændelser:

Shell
wp cron event list | grep blockstudio