Pereiti prie turinio

Cron

cron sistema leidžia apibrėžti suplanuotas užduotis, kurios vykdomos fone nustatytu pasikartojančiu intervalu. Įtraukite cron.php failą į savo bloko katalogą, o Blockstudio užregistruos užduotis naudodama WordPress Cron ir valdys jų gyvavimo ciklą. Atskirai įdiegti papildiniai išvalo savo užduotis, kai yra išjungiami. Composer, įdiegtoms kartu su tema ar kitu papildiniu, reikia pagrindinio komponento atliekamo išvalymo arba wp bs teardown prieš išjungiant, pakeičiant ar pašalinant pagrindinį komponentą.

Tai paskutinė viso paketo bloko modelio dalis: blokas gali turėti UI (index.twig), serverio logiką (rpc.php), nuolatinius duomenis (db.php) ir dabar – foninį apdorojimą (cron.php).

Kaip tai veikia

  1. Sukuriate cron.php savo bloko kataloge
  2. Ji grąžina asociatyvųjį masyvą su pavadintomis užduotimis
  3. Kiekvieną kartą įkeliant puslapį, Blockstudio patikrina, ar užduotys suplanuotos
  4. Trūkstami tvarkaraščiai užregistruojami naudojant wp_schedule_event()
  5. WordPress Cron vykdo atgalinio iškvietimo funkcijas nustatytu intervalu
  6. Išjungus atskirai įdiegtą Blockstudio papildinį, visi Blockstudio cron įvykiai atšaukiami; įdiegimams kartu naudojami toliau nurodyti išvalymo būdai
Kodas
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Užduočių apibrėžimas

Grąžinkite asociatyvųjį užduočių masyvą. Kiekviena užduotis gali būti tiesioginis iškvietimas (numatytasis nustatymas – daily) arba masyvas su schedule ir 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 savosios apibrėžtys

cron.php taip pat gali grąžinti objektą su metodais, priskirtais atributams. Taip gaunama tvarkingesnė PHP aplinka, išlaikant esamą masyvo sintaksę.

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

Pagal numatytuosius nustatymus metodų pavadinimai paverčiami mažosiomis raidėmis ir snake case formatu, todėl cleanupOldEntries() tampa cleanup_old_entries. Jei reikia aiškaus užduoties pavadinimo, naudokite name:.

Tvarkaraščiai

Integruoti

WordPress iš karto pateikia šiuos tvarkaraščius:

Tvarkaraštis Intervalas
hourly Kas valandą
twicedaily Kas 12 valandų
daily Kas 24 valandas
weekly Kas 7 dienas

Tinkinti intervalai

Užregistruokite tinkintus intervalus naudodami filtrą WordPress cron_schedules, tada nurodykite juos 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 () { /* ... */ },
    ],
];

Dažni šablonai

Duomenų priežiūra

Išvalykite senus įrašus, užbaikite bandomuosius laikotarpius, archyvuokite neaktyvius elementus:

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

Išorinių API sinchronizavimas

Pagal tvarkaraštį gaukite duomenis iš trečiųjų šalių paslaugų:

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

Pranešimai ir suvestinės

Siųskite periodines ataskaitas arba pranešimus el. paštu:

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

Išjungimas

Kai Blockstudio įdiegiama kaip atskiras papildinys, jį išjungus automatiškai atšaukiami visi Blockstudio cron įvykiai.

Temoje ar kitame papildinyje įdiegta Composer neturi atskiro išjungimo kablio. Išjungus pagrindinį papildinį, perėjus nuo pagrindinės temos prie kitos arba pašalinus kartu įdiegtą kodą, įvykiai lieka suplanuoti, nebent pagrindinis komponentas juos išvalo. Prieš atlikdami bet kurį iš šių veiksmų, paleiskite išvalymo komandą:

Shell
wp bs teardown

Ji atšaukia kiekvieną Blockstudio cron įvykį ir pašalina statinio išankstinio atvaizdavimo būseną, kuri priklauso šiam diegimui. Išsamesnę informaciją rasite CLI.

Komanda pasiekiama tik kol Blockstudio vis dar įkelta. Pagrindinis papildinys gali užregistruoti išvalymą savo pagrindiniame papildinio faile:

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

Kartu įdiegta tema tą patį atgalinio iškvietimo funkcijos kodą gali naudoti su switch_theme. Užregistruokite jį, kol įkelta senoji tema, o ne kitos temos after_switch_theme kablyje:

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

Cron::unschedule_all() pašalina visus Blockstudio cron įvykius, o ne tik vieno bloko ar pagrindinio komponento užduotis. Šie kabliai nepašalina statinio išankstinio atvaizdavimo būsenos; kai pašalinate visą įdiegimą, naudokite wp bs teardown. Jei neišvalysite, pasikartojantys įvykiai liks WordPress ir gali vėl būti vykdomi, jei bloko kodas bus įdiegtas iš naujo.

Filtras

Programiškai keiskite arba išjunkite užduotis:

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

Derinimas

WordPress Cron suaktyvinamas apsilankius puslapyje, o ne sistemos lygmens planuokle. Mažai lankomose svetainėse užduotys gali būti vykdomos ne tiksliai pagal tvarkaraštį. Kad vykdymo laikas būtų patikimas, nustatykite tikrą sistemos cron, kuris pasiektų wp-cron.php:

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

Tada išjunkite integruotą WordPress cron aktyviklį faile wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Norėdami patikrinti suplanuotus įvykius, naudokite WP-CLI:

Shell
wp cron event list | grep blockstudio