How to use embed_handler_html filter in WordPress

embed_handler_html filter

To use the embed_handler_html filter, first, you have to register it using add_filter. You can write this code into the 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_handler_html_defaults which takes 3 parameters and we registered using add_filter. The first parameter embed_handler_html is the name of the hook, the second parameter weplugins_modify_embed_handler_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_handler_html filter.

Parameters

Below are the 3 parameters required to use this hook.

• $return: (string|false) The HTML result of the shortcode, or false on failure.
• $url: (string) The embed URL.
• $attr: (array) An array of shortcode attributes.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "embed_handler_html", "weplugins_modify_embed_handler_html_defaults", 10, 3 );
    

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

Live Example 3

Another practical example to modify the embed HTML.

    function weplugins_custom_embed_handler_html($return, $url, $attr) {
        // Custom modification to the $return HTML
        $return .= '<div class="custom-class">Custom Embed Content</div>';
        return $return;
    }
    // add the filter
    add_filter("embed_handler_html", "weplugins_custom_embed_handler_html", 10, 3);
    

Contact Us

If you need any customization or are having trouble using this hook, please contact us.