Pāriet uz saturu

Cron

Sistēma cron ļauj definēt ieplānotus uzdevumus, kas fonā tiek izpildīti atkārtoti noteiktā intervālā. Pievienojiet cron.php failu sava bloka direktorijai, un Blockstudio reģistrēs uzdevumus ar WordPress Cron un pārvaldīs to dzīves ciklu. Atsevišķi instalēti spraudņi deaktivizēšanas laikā iztīra savus uzdevumus. Instalācijām Composer, kas iekļautas tēmā vai citā spraudnī, nepieciešama resursdatora puses tīrīšana vai wp bs teardown pirms resursdatora deaktivizēšanas, nomaiņas vai noņemšanas.

Šī ir pilna steka bloku modeļa pēdējā daļa: jūsu blokam var būt UI (index.twig), servera loģika (rpc.php), pastāvīgi dati (db.php) un tagad arī fona apstrāde (cron.php).

Kā tas darbojas

  1. Izveidojiet cron.php sava bloka direktorijā
  2. Tas atgriež asociatīvu masīvu ar nosauktiem uzdevumiem
  3. Katras lapas ielādes laikā Blockstudio pārbauda, vai uzdevumi ir ieplānoti
  4. Trūkstošie grafiki tiek reģistrēti ar wp_schedule_event()
  5. WordPress Cron izpilda atzvanus noteiktajā intervālā
  6. Atsevišķi instalēta spraudņa Blockstudio deaktivizēšanas laikā visi Blockstudio cron notikumi tiek atcelti; komplektētās instalācijās izmantojiet tālāk aprakstītos tīrīšanas ceļus
Kods
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Uzdevumu definēšana

Atgrieziet asociatīvu masīvu ar uzdevumiem. Katrs uzdevums var būt tieša atzvanīšanas funkcija (pēc noklusējuma daily) vai masīvs ar schedule un 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 vietējās definīcijas

cron.php var atgriezt arī objektu ar atribūtiem piešķirtām metodēm. Tas nodrošina tīrāku, PHP raksturīgu saskarni, saglabājot esošo masīva sintaksi.

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

Metožu nosaukumi pēc noklusējuma tiek normalizēti uz mazajiem burtiem ar pasvītrojumiem, tāpēc cleanupOldEntries() kļūst par cleanup_old_entries. Izmantojiet name:, ja vajadzīgs skaidri norādīt uzdevuma nosaukumu.

Grafiki

Iebūvētie

WordPress jau sākotnēji nodrošina šādus grafikus:

Grafiks Intervāls
hourly Ik stundu
twicedaily Ik pēc 12 stundām
daily Ik pēc 24 stundām
weekly Ik pēc 7 dienām

Pielāgoti intervāli

Reģistrējiet pielāgotus intervālus, izmantojot filtru WordPress cron_schedules, un pēc tam norādiet tos sadaļā 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 () { /* ... */ },
    ],
];

Biežākie lietošanas veidi

Datu uzturēšana

Iztīriet vecos ierakstus, beidziet izmēģinājuma periodus un arhivējiet neaktīvos ierakstus:

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

Ārējo API sinhronizācija

Pēc grafika iegūstiet datus no trešo pušu pakalpojumiem:

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

Paziņojumi un kopsavilkumi

Sūtiet periodiskus pārskatus vai paziņojumu e-pasta ziņojumus:

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

Deaktivizēšana

Ja Blockstudio ir instalēts kā atsevišķs spraudnis, tā deaktivizēšana automātiski atceļ visus Blockstudio cron notikumus.

Instalācijai Composer, kas iekļauta tēmā vai citā spraudnī, nav sava deaktivizēšanas āķa. Deaktivizējot resursdatora spraudni, pārslēdzoties no resursdatora tēmas vai noņemot komplektēto kodu, ieplānotie notikumi paliek, ja vien resursdators neveic tīrīšanu. Pirms jebkuras no šīm darbībām palaidiet noņemšanas komandu:

Apvalks
wp bs teardown

Tā izņem no grafika katru Blockstudio cron notikumu un noņem instalācijas pārvaldīto statisko iepriekšējās renderēšanas stāvokli. Plašāku informāciju skatiet sīkākCLI.

Komanda ir pieejama tikai tad, kamēr Blockstudio joprojām ir ielādēts. Resursdatora spraudnis tīrīšanu var reģistrēt savā galvenajā spraudņa failā:

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

Komplektējošā tēma var izmantot to pašu atzvanu, reģistrējot to ar switch_theme. Reģistrējiet to, kamēr ielādēta vecā tēma, nevis nākamās tēmas after_switch_theme āķī:

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

Cron::unschedule_all() noņem visus Blockstudio cron notikumus, ne tikai viena bloka vai resursdatora uzdevumus. Šie āķi nenoņem statisko iepriekšējas renderēšanas stāvokli; noņemot visu instalāciju, izmantojiet wp bs teardown. Bez tīrīšanas atkārtotie notikumi paliek WordPress un var atsākties, ja bloka kods tiek instalēts vēlreiz.

Filtrs

Modificējiet vai atspējojiet uzdevumus programmatiski:

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

Atkļūdošana

WordPress Cron aktivizē lapas apmeklējumi, nevis sistēmas plānotājs. Vietnēs ar nelielu datplūsmu uzdevumi var netikt palaisti precīzi pēc grafika. Lai nodrošinātu uzticamu izpildes laiku, konfigurējiet īstu sistēmas cron, kas piekļūst vietnei wp-cron.php:

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

Pēc tam atspējojiet iebūvēto cron aktivizētāju WordPress sadaļā wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Lai pārbaudītu ieplānotos notikumus, izmantojiet WP-CLI:

Apvalks
wp cron event list | grep blockstudio