How to use default_contextual_help filter in WordPress

default_contextual_help filter

Filters the default legacy contextual help text.

To use the default_contextual_help 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.

At WePlugins, we 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_default_contextual_help_defaults which takes 1 parameter and we registered it using add_filter. The first parameter default_contextual_help is the name of the hook, the second parameter weplugins_modify_default_contextual_help_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 default_contextual_help filter.

Parameters

Below the 1 parameter is required to use this hook.

• $old_help_default: (string) Default contextual help text.

Live Example

Example 1: Basic Hook Usage

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

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("default_contextual_help", "weplugins_modify_default_contextual_help_defaults", 10, 1);
    

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

Example 3: Conditional Modification

Conditionally modify the contextual help based on specific conditions.

    function weplugins_modify_default_contextual_help_defaults($old_help_default) { 
        if (is_admin()) {
            $old_help_default .= '<p>Additional help text for admins.</p>';
        }
        return $old_help_default; 
    }
    // add the filter
    add_filter("default_contextual_help", "weplugins_modify_default_contextual_help_defaults", 10, 1);
    

Contact Us

If you need any customization or are having trouble using this hook, please Contact Us and we’d be happy to assist you.