pre_unschedule_event

Advertisement

Summery Summery

Filter to preflight or hijack unscheduling of events.

Syntax Syntax

apply_filters( 'pre_unschedule_event', null|bool $pre, int $timestamp, string $hook, array $args )

Description Description

Returning a non-null value will short-circuit the normal unscheduling process, causing the function to return the filtered value instead.

For plugins replacing wp-cron, return true if the event was successfully unscheduled, false if not.

Parameters Parameters

$pre

Value to return instead. Default null to continue unscheduling the event.

$timestamp

Timestamp for when to run the event.

$hook

Action hook, the execution of which will be unscheduled.

$args

Arguments to pass to the hook's callback function.

Source Source

File: wp-includes/cron.php

Advertisement

Changelog Changelog

Changelog
Version Description
5.1.0 Introduced.

Advertisement

Leave a Reply