How to use extra_context_headers filter in WordPress

extra_context_headers filter

The dynamic portion of the hook name, $context, refers to the context where extra headers might be loaded.

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

Parameters

Below the 1 parameter is required to use this hook.

• $extra_context_headers: (array) Empty array by default.

Live Examples

Example 1: Basic Usage

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

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

Example 2: Conditional Modification

This example shows how to modify the headers conditionally.

function weplugins_modify_extra_context_headers_conditional($extra_context_headers) { 
    if (is_admin()) {
        $extra_context_headers[] = 'X-Admin-Header';
    }
    return $extra_context_headers; 
}
// Add the filter
add_filter("extra_context_headers", "weplugins_modify_extra_context_headers_conditional", 10, 1);

Example 3: Removing a Hook

To remove a hook callback, use the example below.

remove_filter("extra_context_headers", "weplugins_modify_extra_context_headers_defaults", 10, 1);

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

Contact Us

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