Liigu sisu juurde

Cron

Süsteem cron võimaldab määrata ajastatud ülesandeid, mis töötavad taustal korduva intervalliga. Lisa oma plokkide kataloogi fail cron.php ja Blockstudio registreerib ülesanded koos WordPress Cron-iga ning haldab nende elutsüklit. Eraldi pluginana paigaldatud versioon eemaldab ülesanded plugina inaktiveerimisel. Composer, mis on komplektis teema või teise pluginaga, vajavad hosti poolset puhastamist või wp bs teardown enne hosti inaktiveerimist, vahetamist või eemaldamist.

See on täisvirna plokimustri viimane osa: plokil võib olla UI (index.twig), serveriloogika (rpc.php), püsivad andmed (db.php) ja nüüd ka taustatöötlus (cron.php).

Kuidas see töötab

  1. Lood cron.php oma plokkide kataloogis
  2. See tagastab assotsiatiivse massiivi nimega ülesannetega
  3. Igal lehe laadimisel kontrollib Blockstudio, kas ülesanded on ajastatud
  4. Puuduvad ajastused registreeritakse funktsiooniga wp_schedule_event()
  5. WordPress Cron käivitab tagasihelistused määratud intervalliga
  6. Eraldiseisva Blockstudio plugina inaktiveerimisel tühistatakse kõik Blockstudio cron sündmused; komplektis olevad paigaldused kasutavad allpool kirjeldatud puhastusteid
Kood
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Tööde määratlemine

Tagastage tööde assotsiatiivne massiiv. Iga töö võib olla otse tagasikutse (vaikimisi daily) või massiiv võtmete schedule ja callback abil:

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-omased määratlused

cron.php võib tagastada ka nimetatud meetoditega objekti. Nii saate selgema PHP-omase kasutusliidese, säilitades samal ajal olemasoleva massiivisüntaksi.

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

Vaikimisi teisendatakse meetodite nimed väiketähtedega snake_case-vormingusse, seega muutub cleanupOldEntries() kujule cleanup_old_entries. Kasutage name:, kui soovite määrata töö nime ise.

Ajastused

Sisseehitatud

WordPress pakub kohe järgmisi ajastusi:

Ajastus Ajavahemik
hourly Iga tund
twicedaily Iga 12 tunni järel
daily Iga 24 tunni järel
weekly Iga 7 päeva järel

Kohandatud ajavahemikud

Registreerige kohandatud ajavahemikud filtri WordPress cron_schedules kaudu ja viidake neile seejärel üksuses 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 () { /* ... */ },
    ],
];

Levinud kasutusmustrid

Andmete hooldus

Kustutage vanad kirjed, lõpetage prooviperioodid ja arhiveerige mitteaktiivsed kirjed:

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

Väliste API-andmete sünkroonimine

Hankige ajastatult andmeid kolmandate osapoolte teenustest:

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

Teavitused ja kokkuvõtted

Saatke perioodilisi aruandeid või teavitusmeile:

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

Deaktiveerimine

Kui Blockstudio on paigaldatud eraldi pluginana, tühistatakse plugina inaktiveerimisel automaatselt kõik Blockstudio cron sündmused.

Teema või teise plugina sees oleval Composer paigaldusel pole oma inaktiveerimiskonksu. Hosti plugina inaktiveerimine, hostteema vahetamine või komplektis oleva koodi eemaldamine jätab sündmused ajastatuks, kui host neid ei puhasta. Käivita lõpetamiskäsk enne mõnda neist toimingutest:

Shell
wp bs teardown

See eemaldab kõigi Blockstudio cron sündmuste ajastuse ja kustutab installatsiooni hallatava staatilise eelt renderdamise oleku. Üksikasju vt jaotisest CLI.

Käsk on saadaval ainult seni, kuni Blockstudio on laaditud. Hosti plugin saab puhastamise registreerida ka oma põhipluginas:

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

Komplektis olev teema saab kasutada sama tagasihelistust funktsioonil switch_theme. Registreeri see vana teema laadimise ajal, mitte järgmise teema after_switch_theme konksul:

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

Cron::unschedule_all() eemaldab kõik Blockstudio cron sündmused, mitte ainult ühe ploki või hosti ülesanded. Need konksud ei eemalda staatilist eelt renderdatud olekut; kogu paigalduse kasutusest kõrvaldamiseks kasuta käsku wp bs teardown. Ilma puhastamiseta jäävad korduvad sündmused üksusesse WordPress ning võivad jätkuda, kui ploki kood uuesti paigaldatakse.

Filtreeri

Muuda töid programmiliselt või keela need:

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

Silumine

WordPress Cron käivitub lehekülgede külastuste, mitte süsteemitaseme ajastaja alusel. Vähese liiklusega saitidel ei pruugi tööd täpselt ajakava järgi käivituda. Täpsema ajastuse jaoks seadista päris süsteemi cron, mis teeb päringu aadressile wp-cron.php:

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

Seejärel keela WordPress sisseehitatud cron käivitaja failis wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Ajastatud sündmuste kontrollimiseks kasuta käsku WP-CLI:

Shell
wp cron event list | grep blockstudio