web-dev-qa-db-ja.com

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に追加し始めたいと思います。私はいくつかの検索をしましたが、すべての検索結果は日付を記入されているか、もはや推奨されないアプローチを使用しています。

私はDeveloperがまだ初期段階にあることを知っていますが、Plugin Handbookは TinyMCE Enhanced Shortcodes そして Shortcode API そして add_shortcode() についてTinyMCEについては触れません。

それで、これは私を私の質問に導きます。 TinyMCEエディタで自動クローズのショートコードをクリック可能なボタンに変えるための基本的な手順は何ですか?

カスタム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;
}

最後に、どのボタンを表示するかを決定します( Content Formatting にボタンの詳細があります)。明らかに、あなたが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関数でわかるように、get_template_directory_uri() .'/plug/custom-em/custom-em.js'の中にJavaScriptファイルを宣言しています。

custom-em.jsファイルを作成したら、これには2つの方法があります。

どちらの場合も、次のショートコード形式[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は疫病であり頭痛を必要としますが、共同で解決することができます。

14