Додайте кнопку закриття короткого коду, що самозамикається, до TinyMCE в WP 4.6

Мені знайоме створення коротких кодів, що закриваються на зразок:

// 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? : відмінна відправна точка, але питання було створено у 2012 році.
Шорт-коди WordPress: Повне керівництво : хороша стаття, але з 2012 року, вона використовує, query_posts()але може бути налаштована
Керівництво по створенню власних кнопок редактора WordPress : це приємна стаття, але ще з давнього часу 2013 року, але вона не охоплює основ та основ використання TinyMCE.

Я знаю, що розробник все ще знаходиться на ранній стадії, але Довідник плагінів лише коротко розповідає про вдосконалені шрифти TinyMCE та API короткого коду, і add_shortcode()не згадують про TinyMCE.

Отже, це призводить мене до мого питання. Яка основна процедура перетворення самозамикаючого короткого коду в кнопку, що можна натискати в редакторі TinyMCE?

plugin-development shortcode tinymce

— ДᴀʀᴛʜВᴀᴅᴇʀ
джерело

Отже, ви маєте на увазі, як створити кнопку в редакторі TinyMCE, яка вводить у вміст самозакриваючись короткий код?

— birgire

@birgire Так, я хотів би знати основу для інтеграції спеціальної кнопки в TinyMCE, яка додасть короткий код до публікації Visual.

— DᴀʀᴛʜVᴀᴅᴇʀ

Ви перевірили чудову відповідь тут від @bueltge?

— birgire

@birgire ні, він не повернувся з мого пошуку, але це хороший запитання

— DᴀʀᴛʜVᴀᴅᴇʀ

Почнемо з додавання спеціальної кнопки 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 - чума і потребує головного болю, але може вирішуватися спільно.

— Крістін Купер
джерело