Preskoči na vsebino

Cron

Sistem cron omogoča določanje načrtovanih opravil, ki se v ozadju izvajajo v rednih intervalih. V imenik bloka dodajte datoteko cron.php, Blockstudio pa opravila registrira v WordPress Cron in upravlja njihov življenjski cikel. Samostojne namestitve vtičnika ob deaktivaciji počistijo svoja opravila. Namestitve Composer, vključene v temo ali drug vtičnik, potrebujejo čiščenje na strani gostitelja ali wp bs teardown, preden gostitelja deaktivirate, zamenjate ali odstranite.

To je zadnji del vzorca bloka s polnim skladom: blok lahko vključuje UI (index.twig), strežniško logiko (rpc.php), trajne podatke (db.php) in zdaj še obdelavo v ozadju (cron.php).

Kako deluje

  1. V imeniku bloka ustvarite cron.php
  2. Vrne asociativno polje poimenovanih opravil
  3. Ob vsakem nalaganju strani Blockstudio preveri, ali so opravila načrtovana
  4. Manjkajoči razporedi se registrirajo v wp_schedule_event()
  5. WordPress Cron sproži povratne klice v določenem intervalu
  6. Ob deaktivaciji samostojnega vtičnika Blockstudio se prekliče razpored vseh dogodkov Blockstudio cron; vključene namestitve uporabijo spodnje postopke čiščenja
Koda
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Določanje opravil

Vrnite asociativno polje opravil. Vsako opravilo je lahko neposreden povratni klic (privzeto daily) ali polje z schedule in 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());
    },
];

Definicije, izvorne za PHP

cron.php lahko vrne tudi objekt z metodami z atributi. Tako dobite preglednejši vmesnik, izvoren za PHP, pri tem pa ohranite obstoječo sintakso polja.

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

Imena metod so privzeto pretvorjena v male črke in zapis snake_case, zato cleanupOldEntries() postane cleanup_old_entries. Če želite izrecno določiti ime opravila, uporabite name:.

Urniki

Vgrajeni

WordPress že vključuje naslednje urnike:

Urnik Interval
hourly Vsako uro
twicedaily Vsakih 12 ur
daily Vsakih 24 ur
weekly Vsakih 7 dni

Intervali po meri

Registrirajte intervale po meri prek filtra WordPress cron_schedules, nato se nanje sklicujte 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 () { /* ... */ },
    ],
];

Pogosti vzorci

Vzdrževanje podatkov

Počistite stare zapise, zaključite preizkusna obdobja, arhivirajte neaktivne vnose:

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

Sinhronizacija zunanjih podatkov API

Načrtovano pridobivajte podatke iz storitev tretjih oseb:

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

Obvestila in povzetki

Pošiljajte redna poročila ali e-poštna obvestila:

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

Deaktivacija

Ko je Blockstudio nameščen kot samostojen vtičnik, se ob njegovi deaktivaciji samodejno prekliče razpored vseh dogodkov Blockstudio cron.

Namestitev Composer v temi ali drugem vtičniku nima lastnega kavlja za deaktivacijo. Če deaktivirate gostiteljski vtičnik, zamenjate gostiteljsko temo ali odstranite vključeno kodo, dogodki ostanejo načrtovani, razen če gostitelj izvede čiščenje. Pred katerim koli od teh dejanj zaženite ukaz za odstranitev:

Lupina
wp bs teardown

Prekliče razporejanje vsakega dogodka Blockstudio cron in odstrani stanje statičnega predizrisovanja, ki ga upravlja namestitev. Za podrobnosti glejte CLI.

Ukaz je na voljo le, dokler je Blockstudio še naložen. Gostiteljski vtičnik lahko čiščenje registrira tudi v glavni datoteki vtičnika:

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

Tema, v katero je vključena koda, lahko uporabi isti povratni klic na switch_theme. Registrirajte ga, dokler je stara tema še naložena, ne pa v kavlju after_switch_theme naslednje teme:

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

Cron::unschedule_all() odstrani vse dogodke Blockstudio cron, ne le opravil enega bloka ali gostitelja. Ti kavlji ne odstranijo statičnega stanja vnaprejšnjega izrisovanja; pri odstranitvi celotne namestitve uporabite wp bs teardown. Brez čiščenja ponavljajoči se dogodki ostanejo v WordPress in se lahko znova sprožijo, če znova namestite kodo bloka.

Filtriranje

Opravila spreminjajte ali onemogočite programsko:

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

Odpravljanje napak

WordPress Cron se sproži ob obiskih strani, ne prek sistemskega razporejevalnika. Na spletnih mestih z malo prometa se opravila morda ne bodo izvedla točno po urniku. Za zanesljivo časovno izvajanje nastavite pravi sistemski cron, ki kliče wp-cron.php:

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

Nato v wp-config.php onemogočite vgrajeni sprožilec cron za WordPress:

PHP
define('DISABLE_WP_CRON', true);

Za pregled načrtovanih dogodkov uporabite WP-CLI:

Lupina
wp cron event list | grep blockstudio