wp_clear_scheduled_hook

SummerySummery

Unschedules all events attached to the hook with the specified arguments.

Syntax

wp_clear_scheduled_hook( string $hook, array $args = array() )

DescriptionDescription

Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the PHP documentation. Use the === operator for testing the return value of this function.

ParametersParameters

$hook

(string) (Required) Action hook, the execution of which will be unscheduled.

$args

(array) (Optional) Arguments that were to be passed to the hook's callback function.

Default value: array()

ReturnReturn

(int|false) On success an integer indicating number of events unscheduled (0 indicates no events were registered with the hook and arguments combination), false if unscheduling one or more events fail.

SourceSource

File: wp-includes/cron.php


			

ChangelogChangelog

Changelog
Version Description
5.1.0 Return value modified to indicate success or failure, 'pre_clear_scheduled_hook' filter added to short-circuit the function.
2.1.0 Introduced.
Scroll to Top