How to use embed_oembed_html filter in WordPress

embed_oembed_html filter

To use the embed_oembed_html 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 weplugins_modify_embed_oembed_html_defaults which takes 4 parameters and we registered using add_filter. The first parameter embed_oembed_html is the name of the hook, the second parameter weplugins_modify_embed_oembed_html_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 embed_oembed_html filter.

Parameters

Below are the 4 parameters required to use this hook.

• $cache : (string|false) The cached HTML result, stored in post meta.
• $url : (string) The attempted embed URL.
• $attr : (array) An array of shortcode attributes.
• $post_ID : (int) Post ID.

Live Example 1: Basic Usage

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

function weplugins_modify_embed_oembed_html_defaults($cache, $url, $attr, $post_ID) { 
    // Update the $cache variable according to your website requirements and return this variable. You can modify the $cache variable conditionally too if you want.
    return $cache; 
}
// add the filter
add_filter("embed_oembed_html", "weplugins_modify_embed_oembed_html_defaults", 10, 4);

Live Example 2: Conditional Modification

This example shows how to modify the embed HTML conditionally based on the URL.

function weplugins_modify_embed_oembed_html_conditionally($cache, $url, $attr, $post_ID) { 
    if (strpos($url, 'youtube') !== false) {
        $cache = '<div class="youtube-embed">' . $cache . '</div>';
    }
    return $cache; 
}
// add the filter
add_filter("embed_oembed_html", "weplugins_modify_embed_oembed_html_conditionally", 10, 4);

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter("embed_oembed_html", "weplugins_modify_embed_oembed_html_defaults", 10, 4);

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.