apply_filters( 'mce_external_plugins', array $external_plugins, string $editor_id )

Filters the list of TinyMCE external plugins.


Description Description

The filter takes an associative array of external plugins for TinyMCE in the form ‘plugin_name’ => ‘url’.

The url should be absolute, and should include the js filename to be loaded. For example: ‘myplugin’ => ‘http://mysite.com/wp-content/plugins/myfolder/mce_plugin.js‘.

If the external plugin adds a button, it should be added with one of the ‘mce_buttons’ filters.


Top ↑

Parameters Parameters

$external_plugins

(array) An array of external TinyMCE plugins.

$editor_id

(string) Unique editor identifier, e.g. 'content'. Accepts 'classic-block' when called from block editor's Classic block.


Top ↑

More Information More Information

This filter may be useful for loading any of the TinyMCE core plugins, many of which are not included by default in WordPress, as well as any custom TinyMCE plugins you may want to create.

Plugin Version Compatibility:

TinyMCE plugins must be compatible with the version of TinyMCE included in WordPress.

It may also be helpful to check when the particular plugin was introduced. For example, the visualblocks plugin was introduced in TinyMCE version 3.5b1.

WordPress 3.9 had a major update with TinyMCE 4.0.

If you find that your plugin script is not getting added, make sure you are adding your plugin ‘id’ => scripturl with the ‘mce_external_plugins’ filter, but not the ‘tiny_mce_plugins’ filter, or else the script file will not be registered.


Top ↑

Source Source

File: wp-includes/class-wp-editor.php

View on Trac



Top ↑

Changelog Changelog

Changelog
Version Description
5.3.0 The $editor_id parameter was added.
2.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by stevenlinx

    Example migrated from Codex:

    Visualblock plugin

    For example, you might create a WordPress plugin that loads the TinyMCE plugin visualblocks.

    TinyMCE plugins typically consist of a javascript file named ‘editor_plugin.js’ and a series of CSS files and other helper files. This example assumes the WordPress plugin stores TinyMCE plugins as follows: example_plugin/tinymce/visualblocks/edior_plugin.js

    /**
     * Add the TinyMCE VisualBlocks Plugin.
     *
     * @param array $plugins An array of all plugins.
     * @return array
     */
    function my_custom_plugins( $plugins ) {
         $plugins['visualblocks'] = plugins_url( 'tinymce/', __FILE__ ) . 'visualblocks/editor_plugin.js';
         return $plugins;
    }
    add_filter( 'mce_external_plugins', 'my_custom_plugins' );
    
  2. Skip to note 2 content
    Contributed by stevenlinx

    Example migrated from Codex:

    Creating a shortcode and a tag button

    First, create a plugin that registers the buttons and their JavaScript.

    /* Plugin Name: My TinyMCE Buttons */
    add_action( 'admin_init', 'my_tinymce_button' );
    
    function my_tinymce_button() {
         if ( current_user_can( 'edit_posts' ) && current_user_can( 'edit_pages' ) ) {
              add_filter( 'mce_buttons', 'my_register_tinymce_button' );
              add_filter( 'mce_external_plugins', 'my_add_tinymce_button' );
         }
    }
    
    function my_register_tinymce_button( $buttons ) {
         array_push( $buttons, "button_eek", "button_green" );
         return $buttons;
    }
    
    function my_add_tinymce_button( $plugin_array ) {
         $plugin_array['my_button_script'] = plugins_url( '/mybuttons.js', __FILE__ ) ;
         return $plugin_array;
    }
    

    Then, in the same folder as the plugin, the JavaScript file mybuttons.js. We add our two buttons (eek and green), one is a direct onclick that inserts a Shortcode and the other is a command that adds an h3 tag to the selected text in the editor.

    (function() {
         /* Register the buttons */
         tinymce.create('tinymce.plugins.MyButtons', {
              init : function(ed, url) {
                   /**
                   * Inserts shortcode content
                   */
                   ed.addButton( 'button_eek', {
                        title : 'Insert shortcode',
                        image : '../wp-includes/images/smilies/icon_eek.gif',
                        onclick : function() {
                             ed.selection.setContent('[myshortcode]');
                        }
                   });
                   /**
                   * Adds HTML tag to selected content
                   */
                   ed.addButton( 'button_green', {
                        title : 'Add span',
                        image : '../wp-includes/images/smilies/icon_mrgreen.gif',
                        cmd: 'button_green_cmd'
                   });
                   ed.addCommand( 'button_green_cmd', function() {
                        var selected_text = ed.selection.getContent();
                        var return_text = '';
                        return_text = '<h1>' + selected_text + '</h1>';
                        ed.execCommand('mceInsertContent', 0, return_text);
                   });
              },
              createControl : function(n, cm) {
                   return null;
              },
         });
         /* Start the buttons */
         tinymce.PluginManager.add( 'my_button_script', tinymce.plugins.MyButtons );
    })();
    

    You can pass PHP values to the JavaScript file printing directly in admin_head:

    foreach ( array('post.php','post-new.php') as $hook ) {
         add_action( "admin_head-$hook", 'my_admin_head' );
    }
    
    /**
     * Localize Script
     */
    function my_admin_head() {
        $plugin_url = plugins_url( '/', __FILE__ );
        ?>
    <!-- TinyMCE Shortcode Plugin -->
    <script type='text/javascript'>
    var my_plugin = {
        'url': '<?php echo $plugin_url; ?>',
    };
    </script>
    <!-- TinyMCE Shortcode Plugin -->
        <?php
    }
    

    And then, access it in mybuttons.js with console.log(my_plugin.url);.

You must log in before being able to contribute a note or feedback.