How to use get_schedule filter in WordPress

get_schedule filter

Filters the schedule for a hook.

To use the get_schedule filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_get_schedule_defaults which takes 3 parameters and we registered it using add_filter. The first parameter get_schedule is the name of the hook, the second parameter weplugins_modify_get_schedule_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove get_schedule filter.

Parameters

Below are the 3 parameters required to use this hook.

• $schedule: (string|false) Schedule for the hook. False if not found.
• $hook: (string) Action hook to execute when cron is run.
• $args: (array) Arguments to pass to the hook’s callback function.

Live Example 1: Basic Usage

The example below shows how you can use this hook.

    function weplugins_modify_get_schedule_defaults($schedule, $hook, $args) {
        // Update the $schedule variable according to your website requirements and return this variable. You can modify the $schedule variable conditionally too if you want.
        return $schedule;
    }
    // Add the filter
    add_filter("get_schedule", "weplugins_modify_get_schedule_defaults", 10, 3);
    

Live Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("get_schedule", "weplugins_modify_get_schedule_defaults", 10, 3);
    

Make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Live Example 3: Conditional Schedule Modification

Modify the schedule conditionally based on the hook name.

    function weplugins_modify_get_schedule_conditionally($schedule, $hook, $args) {
        if ($hook == 'my_custom_hook') {
            // Change the schedule only for 'my_custom_hook'
            $schedule = 'hourly';
        }
        return $schedule;
    }
    // Add the filter
    add_filter("get_schedule", "weplugins_modify_get_schedule_conditionally", 10, 3);
    

Contact Us

If you need customization, feel free to Contact Us.