Adicione o botão shortcode de fechamento automático ao TinyMCE no WP 4.6

Question

Adicione o botão shortcode de fechamento automático ao TinyMCE no WP 4.6

#1 resposta do Christine Cooper (14 votos)

11

Estou familiarizado com a criação de códigos de acesso de fechamento automático, como:

// 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' );

mas gostaria de começar a adicioná-las ao TinyMCE. Fiz várias pesquisas, mas todos os resultados da pesquisa são datados ou usam uma abordagem que não é mais recomendada:

Como adicionar um botão de código de acesso ao editor do TinyMCE ? : excelente ponto de partida, mas a questão foi criada em 2012.
Shortcodes do WordPress: Um guia completo : bom artigo, mas a partir de 2012 e usa query_posts() , mas poderia ser ajustado
Guia para criar seus próprios botões do editor WordPress : é um bom artigo, mas ainda há algum tempo, 2013, mas não abrange os princípios básicos ou a base para usar o TinyMCE.

Eu sei que o Developer ainda está em seus estágios iniciais, mas o Manual do Plugin apenas fala brevemente sobre Shortcodes Aprimorados do TinyMCE e API de códigos curtos e add_shortcode() não menciona o TinyMCE.

Então isso me leva à minha pergunta. Qual é o procedimento básico para transformar um shortcode com fechamento automático em um botão clicável no editor TinyMCE?

plugin-development tinymce shortcode

por DᴀʀᴛʜVᴀᴅᴇʀ 22.07.2016 / 20:28

1 resposta

Tags plugin-development tinymce shortcode

Como adicionar uma capacidade a uma função de usuário? Alterando a mensagem “Plugin Activated” Default

score 14 · Accepted Answer

Começamos adicionando o botão TinyMCE personalizado:

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');

Em seguida, declaramos e registramos o novo botão:

// 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;
}

Finalmente, decidimos quais botões (mais nos botões podem ser encontrados em Formatação de conteúdo ) que deseja exibir. Obviamente, se você tiver UX em mente, exibirá apenas alguns deles, por exemplo:

// 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' );

Como você pode ver na função add_tinymce_plugin_custom_em , estamos declarando um arquivo javascript dentro de get_template_directory_uri() .'/plug/custom-em/custom-em.js'

Portanto, crie o arquivo custom-em.js e, em seguida, você tem duas maneiras de fazer isso.

Você pode usar o seguinte formato de código de acesso [shortcode foo="" bar=""] ou [shortcode][/shortcode] .

Vamos começar com o formato [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);
})();

Como você pode ver, usamos uma imagem como o ícone do botão. Você pode alterar isso no texto, conforme descrito no exemplo abaixo.

Seguimos o que usamos em nossa própria plataforma, ela envolve a seleção 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);

Por favor, poste resultados e realize edições. O TinyMCE é uma praga e requer dor de cabeça, mas pode ser resolvido de forma colaborativa.