How to use contextual_help_list filter in WordPress

contextual_help_list filter

Filters the legacy contextual help list.

To use the *contextual_help_list* 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_contextual_help_list_defaults` which takes 2 parameters and we registered using `add_filter`. The first parameter `contextual_help_list` is the name of the hook, the second parameter `weplugins_modify_contextual_help_list_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 *contextual_help_list* filter.

Parameters

Below are the 2 parameters required to use this hook.

• $old_compat_help : (array) Old contextual help.
• $screen : (WP_Screen) Current WP_Screen instance.

Live Example

apply_filters_deprecated( 'contextual_help_list', array $old_compat_help, WP_Screen $screen )

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

Example 1: Modify Contextual Help List

In this example, we modify the contextual help list based on certain conditions.

    function weplugins_modify_contextual_help_list_defaults($old_compat_help, $screen) { 
        // Update the $old_compat_help variable according to your website requirements and return this variable. You can modify the $old_compat_help variable conditionally too if you want.
        return $old_compat_help; 
    }
    // Add the filter
    add_filter( "contextual_help_list", "weplugins_modify_contextual_help_list_defaults", 10, 2 );
    

Example 2: Remove Contextual Help List Hook

To remove a hook callback, use the example below.

    remove_filter( "contextual_help_list", "weplugins_modify_contextual_help_list_defaults", 10, 2 );
    

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

Example 3: Conditional Modification of Help List

Modify the help list only for a specific screen.

    function weplugins_modify_contextual_help_list_defaults($old_compat_help, $screen) { 
        // Check if the current screen is the desired one
        if ( $screen->id === 'desired_screen_id' ) {
            // Modify the $old_compat_help variable
        }
        return $old_compat_help; 
    }
    // Add the filter
    add_filter( "contextual_help_list", "weplugins_modify_contextual_help_list_defaults", 10, 2 );
    

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.