How to use excerpt_allowed_wrapper_blocks filter in WordPress

excerpt_allowed_wrapper_blocks filter

Filters the list of blocks that can be used as wrapper blocks, allowing excerpts to be generated from the innerBlocks of these wrappers.

To use excerpt_allowed_wrapper_blocks 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.

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_excerpt_allowed_wrapper_blocks_defaults which takes 1 parameter and we registered using add_filter. The first parameter excerpt_allowed_wrapper_blocks is the name of the hook, the second parameter modify_excerpt_allowed_wrapper_blocks_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 excerpt_allowed_wrapper_blocks filter.

Parameters

Below the 1 parameter is required to use this hook.

• $allowed_wrapper_blocks : (string[]) The list of names of allowed wrapper blocks.

Live Example

apply_filters('excerpt_allowed_wrapper_blocks', string[] $allowed_wrapper_blocks)

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

Example 1: Basic Usage

This example shows how to modify the allowed wrapper blocks.

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

Example 2: Conditional Modification

This example conditionally modifies the allowed wrapper blocks based on certain criteria.

    function weplugins_modify_excerpt_allowed_wrapper_blocks_conditionally($allowed_wrapper_blocks) {
        if (/* some condition */) {
            // Modify $allowed_wrapper_blocks based on condition
        }
        return $allowed_wrapper_blocks;
    }
    add_filter("excerpt_allowed_wrapper_blocks", "weplugins_modify_excerpt_allowed_wrapper_blocks_conditionally", 10, 1);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("excerpt_allowed_wrapper_blocks", "weplugins_modify_excerpt_allowed_wrapper_blocks_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.