How to use oembed_dataparse filter in WordPress

oembed_dataparse filter

Use this filter to add support for custom data types, or to filter the result.

To use the oembed_dataparse 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_oembed_dataparse_defaults which takes 3 parameters and we registered it using add_filter. The first parameter oembed_dataparse is the name of the hook, the second parameter modify_oembed_dataparse_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 oembed_dataparse filter.

Parameters

Below are the 3 parameters required to use this hook:

• $return: (string) The returned oEmbed HTML.
• $data: (object) A data object result from an oEmbed provider.
• $url: (string) The URL of the content to be embedded.

Live Examples

Example 1: Wrap oEmbed Data

This example demonstrates how you can wrap oEmbed data using the filter.

    function weplugins_wrap_oembed_dataparse($return, $data, $url) {
        $mod = '';
        if  ( ( $data->type == 'video' ) &&
              ( isset($data->width) ) && ( isset($data->height) ) &&
              ( round($data->height/$data->width, 2) == round( 3/4, 2) )
            )
        {
            $mod = 'embed-responsive--4-3';
        }
        return $return;
    }
    add_filter("oembed_dataparse", "weplugins_wrap_oembed_dataparse", 10, 3);
    

Example 2: Modify oEmbed Data Parse Defaults

Below is an example of how you can use this hook to modify oEmbed data parse defaults.

    function weplugins_modify_oembed_dataparse_defaults($return, $data, $url) { 
        // 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("oembed_dataparse", "weplugins_modify_oembed_dataparse_defaults", 10, 3);
    

Example 3: Remove oEmbed Data Parse Filter

To remove a hook callback, use the example below.

    remove_filter("oembed_dataparse", "weplugins_modify_oembed_dataparse_defaults", 10, 3);
    

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.