How to use oembed_response_data filter in WordPress

oembed_response_data Filter

Filters the oEmbed response data.

To use the oembed_response_data filter, you first need 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 prefers 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_oembed_response_data_defaults which takes 4 parameters and we registered it using add_filter. The first parameter oembed_response_data is the name of the hook, the second parameter weplugins_modify_oembed_response_data_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_response_data filter.

Parameters

Below are the 4 parameters required to use this hook:

• $data : (array) The response data.
• $post : (WP_Post) The post object.
• $width : (int) The requested width.
• $height : (int) The calculated height.

Live Example

apply_filters( 'oembed_response_data', array $data, WP_Post $post, int $width, int $height )

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

    function weplugins_modify_oembed_response_data_defaults($data, $post, $width, $height) { 
        
        // Update the $data variable according to your website requirements and return this variable. You can modify the $data variable conditionally too if you want.

        return $data; 
    }
    // add the filter
    add_filter( "oembed_response_data", "weplugins_modify_oembed_response_data_defaults", 10, 4 );
    

Example 1: Customizing oEmbed Data

Let’s modify the oEmbed response data to append custom information.

    function weplugins_custom_oembed_data($data, $post, $width, $height) { 
        $data['custom_key'] = 'Custom Value';
        return $data; 
    }
    add_filter( "oembed_response_data", "weplugins_custom_oembed_data", 10, 4 );
    

Example 2: Conditional oEmbed Data Modification

Modify the oEmbed response data only if the post type is ‘video’.

    function weplugins_conditional_oembed_data($data, $post, $width, $height) {
        if ( $post->post_type == 'video' ) {
            $data['video_type'] = 'Custom Video Type';
        }
        return $data;
    }
    add_filter( "oembed_response_data", "weplugins_conditional_oembed_data", 10, 4 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below:

    remove_filter( "oembed_response_data", "weplugins_modify_oembed_response_data_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 need customization or are having any trouble using this hook, please Contact Us. We’d be happy to assist you.