How to use mce_buttons filter in WordPress

mce_buttons filter

Filters the first-row list of TinyMCE buttons (Visual tab).

To use the mce_buttons 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 modify_mce_buttons_defaults which takes 2 parameters and we registered using add_filter. The first parameter mce_buttons is the name of the hook, The second parameter modify_mce_buttons_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 mce_buttons filter.

Parameters

Below are the 2 parameters required to use this hook.

• $mce_buttons: (array) First-row list of buttons.
• $editor_id: (string) Unique editor identifier, e.g. ‘content’. Accepts ‘classic-block’ when called from the block editor’s Classic block.

Live Examples

Example 1: Basic Usage

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

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("mce_buttons", "weplugins_modify_mce_buttons_defaults", 10, 2);
    

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

Example 3: Custom Button Modification

Here’s how you can modify the list of buttons:

    function weplugins_custom_mce_buttons($mce_buttons, $editor_id) {
        // Add a custom button to the mce_buttons array
        $mce_buttons[] = 'my_custom_button';
        return $mce_buttons;
    }
    add_filter("mce_buttons", "weplugins_custom_mce_buttons", 10, 2);
    

Contact Us

If you need any customization or assistance using this hook, feel free to contact us.