Siirry sisältöön

Cron

cron-järjestelmällä voit määrittää ajastettuja tehtäviä, jotka suoritetaan taustalla toistuvin väliajoin. Lisää cron.php-tiedosto lohkohakemistoosi, niin Blockstudio rekisteröi tehtävät WordPress Cron -järjestelmään ja hallitsee niiden elinkaarta. Erilliset liitännäisasennukset siivoavat tehtävänsä käytöstä poistamisen yhteydessä. Teemaan tai toiseen liitännäiseen sisällytetyt Composer-asennukset tarvitsevat isännän tekemän siivouksen tai wp bs teardown-komennon ennen kuin isäntä poistetaan käytöstä, vaihdetaan tai poistetaan.

Tämä täydentää täyden pinon lohkomallin: lohkossasi voi olla UI (index.twig), palvelinlogiikka (rpc.php), pysyviä tietoja (db.php) ja nyt myös taustakäsittelyä (cron.php).

Näin se toimii

  1. Luo cron.php lohkohakemistoosi
  2. Se palauttaa assosiatiivisen taulukon nimetyistä tehtävistä
  3. Jokaisella sivulatauksella Blockstudio tarkistaa, onko tehtävät ajastettu
  4. Puuttuvat ajastukset rekisteröidään wp_schedule_event()-järjestelmään
  5. WordPress Cron suorittaa kutsufunktiot määritetyin väliajoin
  6. Kun erillinen Blockstudio-liitännäinen poistetaan käytöstä, kaikki Blockstudio cron -tapahtumat perutaan; sisällytetyt asennukset käyttävät alla olevia siivousmenetelmiä
Koodi
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Tehtävien määrittäminen

Palauta assosiatiivinen taulukko tehtävistä. Kukin tehtävä voi olla suora takaisinkutsu (oletusarvo on daily) tai taulukko, jossa on schedule ja 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-natiivimääritykset

cron.php voi palauttaa myös olion, jossa on nimettyjä metodeja. Tämä tarjoaa siistimmän PHP-natiivin rajapinnan ja säilyttää samalla nykyisen taulukkosyntaksin.

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

Metodien nimet normalisoidaan oletusarvoisesti pienaakkoselliseksi snake case -muodoksi, joten cleanupOldEntries() muuttuu muotoon cleanup_old_entries. Käytä asetusta name:, kun haluat määrittää tehtävän nimen itse.

Ajastukset

Valmiit

WordPress sisältää valmiina seuraavat ajastukset:

Ajastus Aikaväli
hourly Joka tunti
twicedaily 12 tunnin välein
daily 24 tunnin välein
weekly 7 päivän välein

Mukautetut aikavälit

Rekisteröi mukautetut aikavälit suodattimella WordPress cron_schedules ja viittaa niihin sitten kohteessa 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 () { /* ... */ },
    ],
];

Yleisiä käyttötapoja

Tietojen ylläpito

Siivoa vanhat tietueet, päätä kokeilujaksot ja arkistoi passiiviset merkinnät:

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

Ulkoisten API-tietojen synkronointi

Nouda tietoja kolmannen osapuolen palveluista ajastetusti:

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

Ilmoitukset ja yhteenvedot

Lähetä säännöllisiä raportteja tai ilmoitussähköposteja:

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

Käytöstä poistaminen

Kun Blockstudio on asennettu omana liitännäisenään, liitännäisen poistaminen käytöstä peruu automaattisesti kaikki Blockstudio cron -tapahtumat.

Teemaan tai toiseen liitännäiseen sisällytetyllä Composer-asennuksella ei ole omaa käytöstä poistamisen koukkua. Isäntäliitännäisen poistaminen käytöstä, isäntäteeman vaihtaminen tai sisällytetyn koodin poistaminen jättää tapahtumat ajastetuiksi, ellei isäntä siivoa niitä. Suorita purkukomento ennen mitään näistä toimista:

Shell
wp bs teardown

Se poistaa ajastuksesta jokaisen Blockstudio cron-tapahtuman ja poistaa asennuksen omistaman staattisen esirenderöintitilan. Katso lisätietoja kohdasta CLI.

Komento on käytettävissä vain niin kauan kuin Blockstudio on ladattuna. Isäntäliitännäinen voi sen sijaan rekisteröidä siivouksen pääliitännäistiedostossaan:

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

Teemaan sisällytetty asennus voi käyttää samaa kutsufunktiota kohteessa switch_theme. Rekisteröi se vanhan teeman ollessa ladattuna, älä seuraavan teeman after_switch_theme-koukussa:

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

Cron::unschedule_all() poistaa kaikki Blockstudio cron -tapahtumat, ei vain yhden lohkon tai isännän tehtäviä. Nämä koukut eivät poista staattista esirenderöityä tilaa; käytä wp bs teardown-komentoa, kun poistat koko asennuksen käytöstä. Ilman siivousta toistuvat tapahtumat säilyvät kohteessa WordPress ja voivat jatkua, jos niiden lohkokoodi asennetaan uudelleen.

Suodatin

Muokkaa tai poista käytöstä tehtäviä ohjelmallisesti:

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

Vianetsintä

WordPress Cron käynnistyy sivukäynneistä, ei järjestelmätason ajastimesta. Vähäliikenteisillä sivustoilla tehtävät eivät välttämättä käynnisty täsmälleen ajallaan. Tarkkaa ajoitusta varten määritä varsinainen järjestelmän cron, joka kutsuu osoitetta wp-cron.php:

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

Poista sitten käytöstä WordPressn sisäänrakennettu cron-käynnistin kohdassa wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Voit tarkistaa ajastetut tapahtumat komennolla WP-CLI:

Shell
wp cron event list | grep blockstudio