Home » Functions » wp_clear_scheduled_hook

Function Name: wp_clear_scheduled_hook

Explanation: The wp_clear_scheduled_hook function is a powerful tool in WordPress that allows developers to remove scheduled actions or events from the system. By calling this function, you can effectively cancel any future executions of a specific action that was previously scheduled using the wp_schedule_event or wp_schedule_single_event functions.

This function can be incredibly useful in scenarios where you need to modify or remove a scheduled task programmatically. For example, let’s say you have a plugin that schedules a daily backup of the WordPress database. However, you want to give users the option to disable this feature. By using wp_clear_scheduled_hook, you can remove the scheduled action for the backup, ensuring that it won’t run anymore.

Example Usage Code:

// Remove the scheduled backup event
function disable_backup_schedule() {
    wp_clear_scheduled_hook( 'daily_backup_event' );
add_action( 'wp_loaded', 'disable_backup_schedule' );

In this example, we have a function called disable_backup_schedule that is hooked to the wp_loaded action. When this action is triggered, the disable_backup_schedule function is called. Within this function, we use the wp_clear_scheduled_hook function to remove the scheduled event with the hook name ‘daily_backup_event’. This ensures that the daily backup will no longer be executed.

By utilizing wp_clear_scheduled_hook, you gain control over the scheduled actions in WordPress, allowing you to manage and manipulate them as needed.

Learn More on WordPress.org

WordPress snippets using the wp_clear_scheduled_hook function

Register an account to save your snippets or go Pro to get more features.