How to use oembed_discovery_links filter in WordPress

oembed_discovery_links filter

Filters the oEmbed discovery links HTML.

To use oembed_discovery_links 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_discovery_links_defaults which takes 1 parameter and we registered using add_filter. The first parameter oembed_discovery_links is the name of the hook, the second parameter modify_oembed_discovery_links_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 oembed_discovery_links filter.

Parameters

Below the 1 parameter is required to use this hook.

• $output: (string) HTML of the discovery links.

Live Example 1: Basic Usage

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

        function weplugins_modify_oembed_discovery_links_defaults($output) { 
            // Update the $output variable according to your website requirements and return this variable.
            // You can modify the $output variable conditionally too if you want.
            return $output; 
        }
        // add the filter
        add_filter( "oembed_discovery_links", "weplugins_modify_oembed_discovery_links_defaults", 10, 1 );
    

Live Example 2: Conditional Modification

Here’s an example on how to conditionally modify the discovery links.

        function weplugins_modify_oembed_discovery_links_conditionally($output) {
            if (is_single()) {
                // Modify $output only for single post pages
                $output .= '<link rel="alternate" type="application/json+oembed" href="https://example.com/oembed?url=' . get_permalink() . '" />';
            }
            return $output;
        }
        // add the filter
        add_filter( "oembed_discovery_links", "weplugins_modify_oembed_discovery_links_conditionally", 10, 1 );
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

        // remove the filter
        remove_filter( "oembed_discovery_links", "weplugins_modify_oembed_discovery_links_defaults", 10, 1 );
    

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 any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.