How to use default_wp_template_part_areas filter in WordPress

default_wp_template_part_areas Filter

Filters the list of allowed template part area values.

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

Parameters

Below the 1 parameter is required to use this hook.

• $default_area_definitions : (array) An array of supported area objects.

Live Examples

Example 1: Basic Hook Usage

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

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

Example 2: Conditional Modification

In this example, we modify the default area definitions conditionally.

    function weplugins_modify_default_wp_template_part_areas_defaults($default_area_definitions) {
        if (is_admin()) {
            // Modify only for admin area
            $default_area_definitions['admin'] = 'Admin Area';
        }
        return $default_area_definitions;
    }
    // Add the filter
    add_filter("default_wp_template_part_areas", "weplugins_modify_default_wp_template_part_areas_defaults", 10, 1);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("default_wp_template_part_areas", "weplugins_modify_default_wp_template_part_areas_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, please contact our WordPress Development Team and we’d be happy to assist you.