How to use recovery_email_support_info filter in WordPress

recovery_email_support_info filter

Filters the support message sent with the fatal error protection email.

To use the recovery_email_support_info 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_email_support_info_defaults which takes 1 parameter and we registered using add_filter. The first parameter recovery_email_support_info is the name of the hook, the second parameter modify_recovery_email_support_info_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 the recovery_email_support_info filter.

Parameters

Below the 1 parameter is required to use this hook.

• $message : (string) The Message to include in the email.

Live Example

apply_filters( 'recovery_email_support_info', string $message )

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

Example 1: Basic Usage

In this example, we modify the support message sent in the fatal error protection email.

    function weplugins_modify_recovery_email_support_info_defaults($message) { 
        // Update the $message variable according to your website requirements and return this variable. You can modify the $message variable conditionally too if you want.
        return $message; 
    }
    // add the filter
    add_filter( "recovery_email_support_info", "weplugins_modify_recovery_email_support_info_defaults", 10, 1 );
    

Example 2: Conditional Message Update

This example shows updating the message conditionally based on certain criteria.

    function weplugins_conditional_recovery_email_support_info($message) { 
        if (some_condition) {
            $message .= " Additional instructions based on condition.";
        }
        return $message; 
    }
    // add the filter
    add_filter( "recovery_email_support_info", "weplugins_conditional_recovery_email_support_info", 10, 1 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "recovery_email_support_info", "weplugins_modify_recovery_email_support_info_defaults", 10, 1 );

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