How to use recovery_mode_begin_url filter in WordPress

recovery_mode_begin_url filter

Filters the URL to begin recovery mode.

To use recovery_mode_begin_url 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 modify_recovery_mode_begin_url_defaults which takes 3 parameters and we registered using add_filter. The first parameter recovery_mode_begin_url is the name of the hook, the second parameter modify_recovery_mode_begin_url_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 recovery_mode_begin_url filter.

Parameters

Below are the 3 parameters required to use this hook:

• $url : (string) The generated recovery mode begin URL.
• $token : (string) The token used to identify the key.
• $key : (string) The recovery mode key.

Live Example

Below is an example of how you can use this hook:

    function weplugins_modify_recovery_mode_begin_url_defaults($url, $token, $key) { 
        // Update the $url variable according to your website requirements and return this variable. You can modify the $url variable conditionally too if you want.
        return $url; 
    }
    // add the filter
    add_filter( "recovery_mode_begin_url", "weplugins_modify_recovery_mode_begin_url_defaults", 10, 3 );
    

Example 1: Custom Recovery URL

In this example, we’ll change the recovery URL to a custom URL:

    function weplugins_custom_recovery_url($url, $token, $key) {
        return 'https://yourwebsite.com/custom-recovery-url/?token=' . $token . '&key=' . $key;
    }
    add_filter('recovery_mode_begin_url', 'weplugins_custom_recovery_url', 10, 3);
    

Example 2: Conditional Recovery URL

Here, we’ll modify the recovery URL based on some condition:

    function weplugins_conditional_recovery_url($url, $token, $key) {
        if (strpos($url, 'specific-condition') !== false) {
            return 'https://yourwebsite.com/special-recovery-url/?token=' . $token . '&key=' . $key;
        }
        return $url;
    }
    add_filter('recovery_mode_begin_url', 'weplugins_conditional_recovery_url', 10, 3);
    

Example 3: Removing the Hook

If you need to remove the hook callback, you can use the following example:

    remove_filter('recovery_mode_begin_url', 'weplugins_modify_recovery_mode_begin_url_defaults', 10, 3);
    

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

Contact Us

If you need any customization, feel free to contact us.