How to use oembed_result filter in WordPress

oembed_result filter

Filters the HTML returned by the oEmbed provider.

To use the oembed_result 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.

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_oembed_result_defaults which takes 3 parameters and we registered it using add_filter. The first parameter oembed_result is the name of the hook, the second parameter weplugins_modify_oembed_result_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_result filter.

Parameters

Below are the 3 parameters required to use this hook.

• $data: (string|false) The returned oEmbed HTML (false if unsafe).
• $url: (string) URL of the content to be embedded.
• $args: (string|array) Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments. Default empty.

Live Examples

Example 1: Basic Usage

Below is an example of how you can use this hook to modify the oEmbed result.

  function weplugins_modify_oembed_result_defaults($data, $url, $args) { 
    // 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_result", "weplugins_modify_oembed_result_defaults", 10, 3 );
  

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

  remove_filter( "oembed_result", "weplugins_modify_oembed_result_defaults", 10, 3 );
  

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

Example 3: Conditional Modification

This example shows how to conditionally modify the oEmbed result based on the URL.

  function weplugins_modify_oembed_result_conditionally($data, $url, $args) { 
    if (strpos($url, 'youtube.com') !== false) {
      // Modify $data only if the URL is a YouTube video
      $data = '<div class="youtube-embed">' . $data . '</div>';
    }
    return $data; 
  }
  // add the filter
  add_filter( "oembed_result", "weplugins_modify_oembed_result_conditionally", 10, 3 );