Добавить самозакрывающуюся кнопку короткого кода в TinyMCE в WP 4.6

11

Я знаком с созданием самозакрывающихся коротких кодов, таких как:

// shortcode
function wpse_shortcode_example( $wpse_atts ) {

    // Attributes
    $wpse_atts = shortcode_atts(
        array(
            'foo' => 'bar',
            'width' => '100%',
            'height' => 'auto',
        ),
        $wpse_atts,
        'wpse'
    );

    // Return
    return '<embed 
             src="' . $wpse_atts['src'] . '"
             width="' . $wpse_atts['width'] . '"
             height="' . $wpse_atts['height'] . '";

}
add_shortcode( 'wpse', 'wpse_shortcode_example' );

но я хотел бы начать добавлять их в TinyMCE. Я сделал несколько поисков, но все результаты поиска либо датированы, либо используют подход, который больше не рекомендуется:

Я знаю, что Разработчик все еще находится на ранних стадиях, но в Руководстве по подключаемым модулям только кратко говорится о расширенных шорткодах TinyMCE и API шорткодов и add_shortcode()не упоминается TinyMCE.

Так что это приводит меня к моему вопросу. Какова основная процедура для превращения самозакрывающегося шорткода в нажимаемую кнопку в редакторе TinyMCE?

DᴀʀᴛʜVᴀᴅᴇʀ
источник
Итак, вы имеете в виду, как создать кнопку в редакторе TinyMCE, которая вставляет самозакрывающийся шорткод в контент?
birgire
1
@birgire Да, я хотел бы знать основы для интеграции пользовательской кнопки в TinyMCE, которая добавит шорткод к визуальному сообщению.
DᴀʀᴛʜVᴀᴅᴇʀ
1
Вы проверили отличный ответ здесь @bueltge?
birgire
@birgire нет, это не вернулось из моих поисков, но это хорошие вопросы и ответы
DᴀʀᴛʜVᴀᴅᴇʀ

Ответы:

14

Начнем с добавления пользовательской кнопки TinyMCE:

function add_mce_button_custom_em() {
    // check user permissions
    if ( !current_user_can( 'edit_posts' ) && !current_user_can( 'edit_pages' ) ) {
        return;
    }
    // check if WYSIWYG is enabled
    if ( 'true' == get_user_option( 'rich_editing' ) ) {
        add_filter( 'mce_external_plugins', 'add_tinymce_plugin_custom_em' );
        add_filter( 'mce_buttons', 'register_mce_button_custom_em' );
    }
}
add_action('admin_head', 'add_mce_button_custom_em');

Затем мы объявляем и регистрируем новую кнопку:

// Declare script for new button
function add_tinymce_plugin_custom_em( $plugin_array ) {
    $plugin_array['custom_em'] = get_template_directory_uri() .'/plug/custom-em/custom-em.js';
    return $plugin_array;
}

// Register new button in the editor
function register_mce_button_custom_em( $buttons ) {
    array_push( $buttons, 'custom_em' );
    return $buttons;
}

Наконец, мы решаем, какие кнопки (подробнее о кнопках можно найти в разделе «Форматирование содержимого» ) мы хотим отобразить. Очевидно, что если вы имеете в виду UX, вы бы отобразили только некоторые из них, например:

// TinyMCE: TinyMCE choose which buttons you want to display
function myformatTinyMCE( $in ) {
    $in['toolbar1'] = 'styleselect,bold,custom_em,blockquote,hr,aligncenter,link,unlink,spellchecker,undo,removeformat';
    return $in;
}
add_filter( 'tiny_mce_before_init', 'myformatTinyMCE' );

Как вы можете видеть в add_tinymce_plugin_custom_emфункции, мы объявляем файл javascript внутриget_template_directory_uri() .'/plug/custom-em/custom-em.js'

Итак, создайте custom-em.jsфайл, и тогда у вас есть два способа сделать это.

Вы можете использовать следующий формат шорткода [shortcode foo="" bar=""]или [shortcode][/shortcode].

Начнем с [shortcode foo="" bar=""]формата:

(function() {
    tinymce.create('tinymce.plugins.custom_em', {
        init : function(ed, url) {
            ed.addButton('custom_em', {
                title : 'Custom EM',
                image : url+'/images/btn_custom_em.png',
                onclick : function() {
                    ed.execCommand(
                        "mceInsertContent",
                        false,
                        "[shortcode foo=\"\" bar=\"\"]"
                    );
                }
            });
        }
    });
    tinymce.PluginManager.add('custom_em', tinymce.plugins.custom_em);
})(); 

Как видите, мы используем изображение в качестве значка кнопки. Вы можете изменить это на текст, как показано в примере ниже.

Следующее - это то, что мы используем на нашей собственной платформе, оно включает в себя выбор <em class="whatever">hello world</em>:

(function() {
    tinymce.PluginManager.add('custom_em', function( editor, url ) {

        editor.on('init', function(e) {
            this.formatter.register('thetarget', {
                inline : 'em',
                classes : 'whatever'
            });
        });

        editor.addButton('custom_em', {
            text: 'Custom EM',
            icon: false,
            onclick : function() {
                var contents = editor.selection.getContent(),
                tags = jQuery(jQuery.parseHTML(contents)).find('em.whatever').andSelf();
                editor.formatter.toggle('thetarget');
            }
        });
    });
})(jQuery);

Пожалуйста, опубликуйте результаты и внесите изменения. TinyMCE - чума и требует головной боли, но может быть решена совместным образом.

Кристина Купер
источник