How to use embed_thumbnail_image_size filter in WordPress

embed_thumbnail_image_size filter

Filters the thumbnail image size for use in the embed template.

To use the embed_thumbnail_image_size 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_embed_thumbnail_image_size_defaults which takes 2 parameters and we register it using add_filter. The first parameter embed_thumbnail_image_size is the name of the hook, the second parameter weplugins_modify_embed_thumbnail_image_size_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 embed_thumbnail_image_size filter.

Parameters

Below are the 2 parameters required to use this hook.

• $image_size: (string) Thumbnail image size.
• $thumbnail_id: (int) Attachment ID.

Live Example 1

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

    function weplugins_modify_embed_thumbnail_image_size_defaults($image_size, $thumbnail_id) { 
        // Update the $image_size variable according to your website requirements and return this variable. You can modify the $image_size variable conditionally too if you want.
        return $image_size; 
    }
    // add the filter
    add_filter( "embed_thumbnail_image_size", "weplugins_modify_embed_thumbnail_image_size_defaults", 10, 2 );
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "embed_thumbnail_image_size", "weplugins_modify_embed_thumbnail_image_size_defaults", 10, 2 );
    

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

Live Example 3

Another use case could be conditionally modifying the image size based on specific post types.

    function weplugins_modify_embed_thumbnail_image_size_for_posts($image_size, $thumbnail_id) {
        if (get_post_type($thumbnail_id) === 'post') {
            $image_size = 'medium';
        }
        return $image_size;
    }
    add_filter( "embed_thumbnail_image_size", "weplugins_modify_embed_thumbnail_image_size_for_posts", 10, 2 );
    

Contact Us

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