How to use get_enclosed filter in WordPress

get_enclosed filter

Filters the list of enclosures already enclosed for the given post.

To use get_enclosed 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_get_enclosed_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_enclosed is the name of the hook, the second parameter weplugins_modify_get_enclosed_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 get_enclosed filter.

Parameters

Below are the 2 parameters required to use this hook.

• $pung: (string[]) Array of enclosures for the given post.
• $post_id: (int) Post ID.

Live Example 1: Basic Usage

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

    function weplugins_modify_get_enclosed_defaults($pung, $post_id) { 
        // Update the $pung variable according to your website requirements and return this variable. You can modify the $pung variable conditionally too if you want.
        return $pung; 
    }
    // add the filter
    add_filter( "get_enclosed", "weplugins_modify_get_enclosed_defaults", 10, 2 );
    

Live Example 2: Conditional Modification

Here is an example where the $pung variable is modified based on a specific condition.

    function weplugins_conditional_modify_get_enclosed($pung, $post_id) { 
        if ($post_id == 42) {
            // Modify $pung only for the post with ID 42
            $pung[] = 'new_enclosure';
        }
        return $pung; 
    }
    // add the filter
    add_filter( "get_enclosed", "weplugins_conditional_modify_get_enclosed", 10, 2 );
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    // remove the filter
    remove_filter( "get_enclosed", "weplugins_modify_get_enclosed_defaults", 10, 2 );
    

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 us and we’d be happy to assist you.