How to use media_buttons action in WordPress

Alright, folks! Let’s dive into the media_buttons action hook in WordPress. This hook fires after the default media button(s) are displayed. First things first, you need to register it using add_action. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin. At WePlugins, we 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 example below, we have defined a function weplugins_execute_on_media_buttons_event which takes 1 parameter and we registered using add_action. The first parameter media_buttons is the name of the hook, the second parameter weplugins_execute_on_media_buttons_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 media_buttons action.

Parameters

• $editor_id: (string) Unique editor identifier, e.g. ‘content’.

Live Example 1

Example of how you can add your own custom media button in the WordPress editor:

    /**
     * Example of how you can add your own custom media button in WordPress editor
     */
    function weplugins_add_media_button() {
        printf('<a href="%s" class="button my-button my-custom-button" id="my-custom-button">' . '<span class="wp-media-buttons-icon dashicons dashicons-art"></span> %s' . '</a>', '#', __('My Custom Button', 'textdomain'));
    }
    add_action('media_buttons', 'weplugins_add_media_button');
    

Live Example 2

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

    function weplugins_execute_on_media_buttons_event($editor_id) {
        // 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('media_buttons', 'weplugins_execute_on_media_buttons_event', 10, 1);
    

Live Example 3

To remove a hook callback, use the example below:

    remove_action('media_buttons', 'weplugins_execute_on_media_buttons_event', 10, 1);
    

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

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.