How to use image_size_names_choose action in WordPress

image_size_names_choose action

Filters the names and labels of the default image sizes.

To use the image_size_names_choose action, first, you have to register it using add_action. 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 execute_on_image_size_names_choose_event which takes 1 parameter and we registered it using add_action. The first parameter image_size_names_choose is the name of the hook, the second parameter execute_on_image_size_names_choose_event 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_action to remove the image_size_names_choose action.

Parameters

Below the 1 parameter is required to use this hook.

• $size_names : (string[]) Array of image size labels keyed by their name. Default values include ‘Thumbnail’, ‘Medium’, ‘Large’, and ‘Full Size’.

Live Example 1: Add Custom Image Sizes

Add image sizes and make them selectable from the WordPress admin.

	function weplugins_custom_theme_setup() {
	    add_image_size('custom-size-1', 1200, 300, true);
	    add_image_size('custom-size-2', 1000, 333, true);
	}
	add_action('after_setup_theme', 'weplugins_custom_theme_setup');
	// Make custom sizes selectable from WordPress admin.
	function weplugins_custom_image_sizes($size_names) {
	    $new_sizes = array(
	        'custom-size-1' => 'Custom Size 1',
	        'custom-size-2' => 'Custom Size 2',
	    );
	    return array_merge($size_names, $new_sizes);
	}
	add_filter('image_size_names_choose', 'weplugins_custom_image_sizes');
	

Live Example 2: Execute Custom Function on Hook

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

	function weplugins_execute_on_image_size_names_choose_event($size_names) {
	    // You can write code here to be executed when this action occurs in WordPress. Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
	}
	// Add the action
	add_action('image_size_names_choose', 'weplugins_execute_on_image_size_names_choose_event', 10, 1);
	

Live Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

	remove_action('image_size_names_choose', 'weplugins_execute_on_image_size_names_choose_event', 10, 1);
	

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

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