Ugrás a tartalomhoz

Cron

A cron rendszer lehetővé teszi, hogy ütemezett feladatokat definiáljon, amelyek ismétlődő időközönként a háttérben futnak. Adjon hozzá egy cron.php fájlt a blokk könyvtárához, és a Blockstudio regisztrálja a feladatokat a WordPress Cron segítségével, valamint kezeli az életciklusukat. Az önálló bővítménytelepítések a feladatokat deaktiváláskor törlik. A sablonba vagy más bővítménybe csomagolt Composer telepítések esetén a befogadó oldali törlésről vagy a wp bs teardown futtatásáról kell gondoskodni, mielőtt a befogadót deaktiválják, lecserélik vagy eltávolítják.

Ez a teljes veremű blokkminta utolsó eleme: a blokk tartalmazhat UI (index.twig), szerveroldali logikát (rpc.php), tartós adatokat (db.php), és most már háttérfeldolgozást is (cron.php).

Működés

  1. Hozza létre a cron.php elemet a blokk könyvtárában
  2. Ez névvel ellátott feladatok asszociatív tömbjét adja vissza
  3. Minden oldalbetöltéskor a Blockstudio ellenőrzi, hogy ütemezve vannak-e a feladatok
  4. A hiányzó ütemezéseket a wp_schedule_event() regisztrálja
  5. A WordPress Cron a megadott időközönként meghívja a visszahívási függvényeket
  6. Az önálló Blockstudio bővítmény deaktiválásakor az összes Blockstudio cron esemény ütemezése törlődik; a csomagolt telepítések az alábbi törlési lehetőségeket használják
Kód
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Feladatok definiálása

Adja vissza a feladatok asszociatív tömbjét. Minden feladat lehet közvetlen visszahívás (alapértelmezés szerint daily), vagy schedule és callback elemeket tartalmazó tömb:

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-natív definíciók

A(z) cron.php attribútumokkal rendelkező metódusokat tartalmazó objektumot is visszaadhat. Így letisztultabb, PHP-natív felületet kap, miközben a meglévő tömbszintaxis változatlan marad.

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

A metódusnevek alapértelmezés szerint kisbetűs snake_case formára alakulnak, ezért a(z) cleanupOldEntries() eredménye cleanup_old_entries lesz. Ha kifejezetten meg szeretné adni a feladat nevét, használja a(z) name: elemet.

Ütemezések

Beépített

A(z) WordPress alapértelmezés szerint a következő ütemezéseket biztosítja:

Ütemezés Időköz
hourly Óránként
twicedaily 12 óránként
daily 24 óránként
weekly 7 naponta

Egyéni időközök

Regisztráljon egyéni időközöket a(z) WordPress cron_schedules szűrővel, majd hivatkozzon rájuk a(z) cron.php elemben:

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 () { /* ... */ },
    ],
];

Gyakori minták

Adatok karbantartása

Régi rekordok törlése, próbaidőszakok lejáratása, inaktív bejegyzések archiválása:

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

Külső API szinkronizálása

Ütemezetten kérjen le adatokat harmadik fél szolgáltatásaiból:

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

Értesítések és összefoglalók

Rendszeres jelentések vagy értesítő e-mailek küldése:

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

Kikapcsolás

Ha a Blockstudio önálló bővítményként van telepítve, a bővítmény deaktiválásakor automatikusan törlődik az összes Blockstudio cron esemény ütemezése.

A sablonba vagy más bővítménybe csomagolt Composer telepítésnek nincs saját deaktiválási horga. A befogadó bővítmény deaktiválásakor, a befogadó sablon lecserélésekor vagy a csomagolt kód eltávolításakor az események ütemezve maradnak, hacsak a befogadó nem hajt végre törlést. A műveletek előtt futtassa a lebontási parancsot:

Shell
wp bs teardown

Ez megszünteti minden Blockstudio cron esemény ütemezését, és eltávolítja azokat a statikus előrenderelési állapotokat, amelyekért a telepítés felel. További részletekért lásd: CLI.

A parancs csak addig érhető el, amíg a Blockstudio be van töltve. A befogadó bővítmény ehelyett regisztrálhat törlést a fő bővítményfájljából:

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

A csomagoló sablon ugyanezt a visszahívási függvényt használhatja a switch_theme eseménynél. Még a régi sablon betöltésekor regisztrálja, ne a következő sablon after_switch_theme horgán:

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

A Cron::unschedule_all() minden Blockstudio cron eseményt töröl, nem csak egyetlen blokkból vagy befogadótól származó feladatokat. Ezek a horgok nem távolítják el a statikus előrenderelési állapotot; a teljes telepítés megszüntetésekor használja a wp bs teardown elemet. Törlés nélkül az ismétlődő események a WordPress helyen maradnak, és újraindulhatnak, ha a blokk kódját ismét telepítik.

Szűrő

Feladatok módosítása vagy letiltása programozottan:

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

Hibakeresés

WordPress Cron oldalmegtekintések hatására fut le, nem rendszerszintű ütemező indítja el. Alacsony forgalmú webhelyeken előfordulhat, hogy a feladatok nem pontosan ütemezés szerint indulnak el. A megbízható időzítéshez állítson be egy valódi rendszerbeli cron-t, amely meghívja a wp-cron.php-t:

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

Ezután tiltsa le a WordPress beépített cron-indítóját itt: wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Az ütemezett események ellenőrzéséhez használja a következőt: WP-CLI:

Shell
wp cron event list | grep blockstudio