Pianifica un evento ricorrente.

Descrizione

Pianifica un hook che verrà attivato da WordPress all'intervallo di tempo specificato. L'azione si attiverà quando qualcuno visiterà il vostro sito WordPress se l'ora programmata è passata.

I valori validi per la ricorrenza sono "ogni ora", "ogni giorno" e "due volte al giorno". Questi possono essere estesi utilizzando il filtro 'cron_schedules' in wp_get_schedules().

Si noti che la programmazione di un evento che si verifichi entro 10 minuti da un evento esistente con lo stesso gancio d'azione sarà ignorata, a meno che non si passi un valore univoco di $args per ogni evento programmato.

Usare wp_next_scheduled() per evitare eventi duplicati.

Usare wp_schedule_single_event() per programmare un evento non ricorrente.

Parametri

$timestamp

(int)(Richiesto)Timestamp Unix (UTC) per la prossima esecuzione dell'evento.

$ricorrenza

(stringa)(Richiesto)La frequenza con cui l'evento deve ripetersi successivamente. Vedere wp_get_schedules() per i valori accettati.

$hook

(stringa)(Richiesto)Gancio di azione da eseguire quando l'evento viene eseguito.

$args

(array)(Opzionale) Array contenente gli argomenti da passare alla funzione di callback del gancio. Ogni valore dell'array viene passato al callback come parametro individuale. Le chiavi dell'array vengono ignorate.

Valore predefinito: array()

$wp_errore

(bool)(Opzionale) Se restituire un WP_Error in caso di fallimento.

Valore predefinito: false

Ritorno

(bool|WP_Error) Vero se l'evento è stato programmato con successo. Falso o WP_Error in caso di fallimento.

Fonte

File: wp-includes/cron.php

functionwp_schedule_event($timestamp,$recurrence,$hook,$args=array(),$wp_error=false){// Make sure timestamp is a positive integer.if(!is_numeric($timestamp)||$timestamp<=0){if($wp_error){returnnewWP_Error('invalid_timestamp',__('Event timestamp must be a valid Unix timestamp.'));}returnfalse;}$schedules=wp_get_schedules();if(!isset($schedules[$recurrence])){if($wp_error){returnnewWP_Error('invalid_schedule',__('Event schedule does not exist.'));}returnfalse;}$event=(object)array('hook'=>$hook,'timestamp'=>$timestamp,'schedule'=>$recurrence,'args'=>$args,'interval'=>$schedules[$recurrence]['interval'],);/** This filter is documented in wp-includes/cron.php */$pre=apply_filters('pre_schedule_event',null,$event,$wp_error);if(null!==$pre){if($wp_error&&false===$pre){returnnewWP_Error('pre_schedule_event_false',__('A plugin prevented the event from being scheduled.'));}if(!$wp_error&&is_wp_error($pre)){returnfalse;}return$pre;}/** This filter is documented in wp-includes/cron.php */$event=apply_filters('schedule_event',$event);// A plugin disallowed this event.if(!$event){if($wp_error){returnnewWP_Error('schedule_event_false',__('A plugin disallowed this event.'));}returnfalse;}$key=md5(serialize($event->args));$crons=_get_cron_array();$crons[$event->timestamp][$event->hook][$key]=array('schedule'=>$event->schedule,'args'=>$event->args,'interval'=>$event->interval,);uksort($crons,'strnatcasecmp');return_set_cron_array($crons,$wp_error);}

Correlato

Utilizzi

Usi Descrizione
wp-includes/cron.php: pre_schedule_event

Filtro per pre-schedulare o dirottare la programmazione di un evento.

wp-includes/cron.php: wp_get_schedules()

Recupera gli orari di ricorrenza degli eventi supportati.

wp-includes/cron.php: _get_cron_array()

Recupera l'opzione dell'array di informazioni di cron.

wp-includes/cron.php: _set_cron_array()

Aggiorna l'opzione cron con il nuovo array cron.

wp-includes/cron.php: programma_evento

Modifica un evento prima che sia programmato.

wp-includes/l10n.php: __()

Recupera la traduzione di $testo.

wp-includes/plugin.php: applica_filtri()

Richiama le funzioni di callback che sono state aggiunte a un gancio per filtri.

wp-includes/load.php: is_wp_error()

Controlla se la variabile data è un errore di WordPress.

wp-includes/class-wp-error.php: WP_Error::__construct()

Inizializza l'errore.

Utilizzato da

Usato da Descrizione
wp-includes/https-detection.php:wp_schedule_https_detection()

Pianifica l'hook di Cron per il rilevamento del supporto HTTPS.

wp-admin/includes/class-wp-site-health.php: WP_Site_Health::maybe_create_scheduled_event()

Crea un evento cron settimanale, se non ne esiste già uno.

wp-includes/class-wp-recovery-mode.php: WP_Recovery_Mode::initialize()

Inizializza la modalità di recupero per la richiesta corrente.

wp-includes/functions.php: wp_schedule_delete_old_privacy_export_files()

Programmare un WP_Cron per eliminare i file di esportazione scaduti.

wp-admin/includes/post.php: get_default_post_to_edit()

Informazioni predefinite sul post da usare quando si popola il modulo "Scrivi un post".

wp-includes/cron.php: wp_reschedule_event()

Riprogramma un evento ricorrente.

wp-includes/update.php: wp_schedule_update_checks()

Pianifica i controlli degli aggiornamenti di core, temi e plugin.

wp-includes/ms-functions.php: wp_schedule_update_network_counts()

Pianifica l'aggiornamento dei conteggi a livello di rete per la rete corrente.

Changelog

Versione Descrizione
5.7.0 Il $wp_error è stato aggiunto.
5.1.0 Valore di ritorno modificato in booleano che indica successo o fallimento, filtro 'pre_schedule_event' aggiunto per cortocircuitare la funzione.
2.1.0 Introdotto.