Μετάβαση στο περιεχόμενο

Cron

Το σύστημα cron σάς επιτρέπει να ορίζετε προγραμματισμένες εργασίες που εκτελούνται στο παρασκήνιο ανά τακτά χρονικά διαστήματα. Προσθέστε ένα αρχείο cron.php στον κατάλογο του block σας και το Blockstudio καταχωρίζει τις εργασίες μέσω των WordPress Cron και διαχειρίζεται τον κύκλο ζωής τους. Οι αυτόνομες εγκαταστάσεις πρόσθετου καθαρίζουν τις εργασίες τους κατά την απενεργοποίηση. Οι εγκαταστάσεις Composer που είναι ενσωματωμένες σε θέμα ή άλλο πρόσθετο χρειάζονται καθαρισμό από το host ή wp bs teardown πριν απενεργοποιηθεί, αλλάξει ή αφαιρεθεί το host.

Αυτό είναι το τελευταίο κομμάτι του μοτίβου block πλήρους στοίβας: το block σας μπορεί να έχει ένα UI (index.twig), λογική διακομιστή (rpc.php), μόνιμα δεδομένα (db.php) και τώρα επεξεργασία παρασκηνίου (cron.php).

Πώς λειτουργεί

  1. Δημιουργείτε το cron.php στον κατάλογο του block σας
  2. Επιστρέφει έναν συσχετιστικό πίνακα με επώνυμες εργασίες
  3. Σε κάθε φόρτωση σελίδας, το Blockstudio ελέγχει αν οι εργασίες είναι προγραμματισμένες
  4. Τα χρονοδιαγράμματα που λείπουν καταχωρίζονται με το wp_schedule_event()
  5. Το WordPress Cron ενεργοποιεί τις συναρτήσεις επανάκλησης στο καθορισμένο διάστημα
  6. Κατά την απενεργοποίηση αυτόνομου πρόσθετου Blockstudio, όλα τα συμβάντα Blockstudio cron αποπρογραμματίζονται· στις ενσωματωμένες εγκαταστάσεις χρησιμοποιούνται οι παρακάτω διαδικασίες καθαρισμού
Κώδικας
blocks/my-block/
├── block.json
├── index.twig
├── rpc.php       ← custom endpoints
├── db.php        ← data model
├── cron.php      ← background tasks
└── style.css

Ορισμός εργασιών

Επιστρέψτε έναν συσχετιστικό πίνακα εργασιών. Κάθε εργασία μπορεί να είναι απευθείας συνάρτηση επανάκλησης (προεπιλογή daily) ή πίνακας με τα schedule και 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

Το cron.php μπορεί επίσης να επιστρέψει ένα αντικείμενο με μεθόδους που έχουν χαρακτηριστικά. Έτσι έχετε μια καθαρότερη διεπαφή εγγενή στο PHP, διατηρώντας παράλληλα άθικτη την υπάρχουσα σύνταξη πίνακα.

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

Τα ονόματα μεθόδων κανονικοποιούνται από προεπιλογή σε πεζά γράμματα με snake case, επομένως το cleanupOldEntries() γίνεται cleanup_old_entries. Χρησιμοποιήστε το name: όταν θέλετε να ορίσετε ρητά ένα όνομα εργασίας.

Προγράμματα

Ενσωματωμένα

Το WordPress παρέχει εξαρχής τα ακόλουθα προγράμματα:

Πρόγραμμα Διάστημα
hourly Κάθε ώρα
twicedaily Κάθε 12 ώρες
daily Κάθε 24 ώρες
weekly Κάθε 7 ημέρες

Προσαρμοσμένα διαστήματα

Καταχωρίστε προσαρμοσμένα διαστήματα μέσω του φίλτρου WordPress cron_schedules και, στη συνέχεια, αναφερθείτε σε αυτά στο 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 () { /* ... */ },
    ],
];

Συνήθη μοτίβα

Συντήρηση δεδομένων

Καθαρίστε παλιές εγγραφές, λήξτε δοκιμαστικές περιόδους και αρχειοθετήστε ανενεργές καταχωρίσεις:

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

Συγχρονισμός εξωτερικών API

Λάβετε δεδομένα από υπηρεσίες τρίτων βάσει προγράμματος:

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

Ειδοποιήσεις και περιλήψεις

Στείλτε περιοδικές αναφορές ή email ειδοποιήσεων:

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

Απενεργοποίηση

Όταν το Blockstudio είναι εγκατεστημένο ως αυτόνομο πρόσθετο, η απενεργοποίηση του πρόσθετου αποπρογραμματίζει αυτόματα όλα τα συμβάντα Blockstudio cron.

Μια εγκατάσταση Composer μέσα σε θέμα ή άλλο πρόσθετο δεν έχει δικό της άγκιστρο απενεργοποίησης. Αν απενεργοποιήσετε το πρόσθετο που τη φιλοξενεί, αλλάξετε το ενεργό θέμα ή αφαιρέσετε τον ενσωματωμένο κώδικα, τα συμβάντα θα παραμείνουν προγραμματισμένα αν το host δεν εκτελέσει καθαρισμό. Εκτελέστε την εντολή τερματισμού πριν κάνετε οποιαδήποτε από αυτές τις ενέργειες:

Κέλυφος
wp bs teardown

Αποπρογραμματίζει κάθε συμβάν Blockstudio cron και αφαιρεί την κατάσταση στατικής προ-απόδοσης που ανήκει στην εγκατάσταση. Δείτε το CLI για λεπτομέρειες.

Η εντολή είναι διαθέσιμη μόνο όσο το Blockstudio εξακολουθεί να είναι φορτωμένο. Ένα πρόσθετο host μπορεί εναλλακτικά να καταχωρίσει τον καθαρισμό από το κύριο αρχείο του:

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

Ένα θέμα που ενσωματώνει το σύστημα μπορεί να χρησιμοποιήσει την ίδια συνάρτηση επανάκλησης στο switch_theme. Καταχωρίστε την όσο είναι φορτωμένο το παλιό θέμα, όχι στο άγκιστρο after_switch_theme του επόμενου θέματος:

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

Το Cron::unschedule_all() αφαιρεί όλα τα συμβάντα Blockstudio cron, όχι μόνο τις εργασίες ενός block ή host. Αυτά τα άγκιστρα δεν αφαιρούν την κατάσταση στατικής προαπόδοσης· χρησιμοποιήστε το wp bs teardown όταν αποσύρετε ολόκληρη την εγκατάσταση. Χωρίς καθαρισμό, τα επαναλαμβανόμενα συμβάντα παραμένουν στο WordPress και μπορεί να συνεχίσουν αν εγκατασταθεί ξανά ο κώδικας του block τους.

Φίλτρο

Τροποποιήστε ή απενεργοποιήστε εργασίες μέσω προγραμματισμού:

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

Εντοπισμός σφαλμάτων

Τα WordPress Cron ενεργοποιούνται με τις επισκέψεις στις σελίδες και όχι από έναν χρονοπρογραμματιστή συστήματος. Σε ιστότοπους με χαμηλή επισκεψιμότητα, οι εργασίες ενδέχεται να μην εκτελούνται ακριβώς την προγραμματισμένη ώρα. Για αξιόπιστο χρονισμό, ρυθμίστε ένα πραγματικό cron συστήματος που καλεί το wp-cron.php:

Κέλυφος
*/5 * * * * curl -s https://yoursite.com/wp-cron.php > /dev/null 2>&1

Στη συνέχεια, απενεργοποιήστε τον ενσωματωμένο μηχανισμό ενεργοποίησης cron του WordPress στο wp-config.php:

PHP
define('DISABLE_WP_CRON', true);

Για να ελέγξετε τα προγραμματισμένα συμβάντα, χρησιμοποιήστε το WP-CLI:

Κέλυφος
wp cron event list | grep blockstudio