How to use embed_thumbnail_image_shape filter in WordPress

Example 1: Applying the Filter

Here’s how you can use the embed_thumbnail_image_shape filter to adjust the shape of your thumbnails.

    function weplugins_modify_embed_thumbnail_image_shape_defaults($shape, $thumbnail_id) { 
        // Update the $shape variable according to your website requirements.
        return $shape; 
    }
    // Add the filter
    add_filter("embed_thumbnail_image_shape", "weplugins_modify_embed_thumbnail_image_shape_defaults", 10, 2);
    

Example 2: Removing a Filter

Sometimes, you might need to remove a registered hook. Use remove_filter as shown below.

    remove_filter("embed_thumbnail_image_shape", "weplugins_modify_embed_thumbnail_image_shape_defaults", 10, 2);
    

Ensure you provide the same callback function name, priority, and arguments when removing the hook callback.

Example 3: Conditional Modification

If you want to conditionally modify the shape, here’s a basic example.

    function weplugins_conditional_embed_thumbnail_image_shape($shape, $thumbnail_id) {
        if (some_condition()) {
            $shape = 'square'; // Or 'rectangular'
        }
        return $shape;
    }
    add_filter("embed_thumbnail_image_shape", "weplugins_conditional_embed_thumbnail_image_shape", 10, 2);
    

Parameters:

• $shape: (string) Thumbnail image shape. Either ‘rectangular’ or ‘square’.
• $thumbnail_id: (int) Attachment ID.