How to use edit_custom_thumbnail_sizes filter in WordPress

edit_custom_thumbnail_sizes filter

Filters whether custom sizes are available options for image editing.

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

Parameters

Below the 1 parameter is required to use this hook.

• $edit_custom_sizes : (bool|string[]) True if custom sizes can be edited or array of custom size names.

Live Example

apply_filters( 'edit_custom_thumbnail_sizes', bool|string[] $edit_custom_sizes )

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

Example 1: Modifying Custom Thumbnail Sizes

This example demonstrates how to modify the custom thumbnail sizes.

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("edit_custom_thumbnail_sizes", "weplugins_modify_edit_custom_thumbnail_sizes_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 Thumbnail Size Modification

This example shows how to conditionally modify the custom thumbnail sizes based on a specific condition.

    function weplugins_modify_edit_custom_thumbnail_sizes_conditionally($edit_custom_sizes) { 
        if (is_admin()) {
            // Modify the $edit_custom_sizes only for admin users
            $edit_custom_sizes = array('custom-size-1', 'custom-size-2');
        }
        return $edit_custom_sizes; 
    }
    // add the filter
    add_filter("edit_custom_thumbnail_sizes", "weplugins_modify_edit_custom_thumbnail_sizes_conditionally", 10, 1); 
    

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.