How to use load_default_embeds filter in WordPress

load_default_embeds filter

Returning a falsey value will prevent loading the default embed handlers.

To use load_default_embeds 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.

WePlugins 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 modify_load_default_embeds_defaults which takes 1 parameter and we registered using add_filter. The first parameter load_default_embeds is the name of the hook, the second parameter modify_load_default_embeds_defaults is the name of the function that 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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove load_default_embeds filter.

Parameters

Below the 1 parameter is required to use this hook.

• $maybe_load_embeds: (bool) Whether to load the embeds library. Default true.

Example 1: Basic Hook Usage

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

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "load_default_embeds", "weplugins_modify_load_default_embeds_defaults", 10, 1 );
    

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

Example 3: Conditional Embed Loading

This example demonstrates conditional logic to determine whether to load the embeds library.

    function weplugins_conditional_load_embeds($maybe_load_embeds) {
        if ( is_admin() ) {
            return false;
        }
        return $maybe_load_embeds;
    }
    add_filter( "load_default_embeds", "weplugins_conditional_load_embeds", 10, 1 );
    

Contact Us

If you’re having any trouble using this hook or need customization, feel free to contact us, and we’d be happy to assist you.