• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「クイックタグAPI」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(Miccwebトーク)による第8325版を取り消し)
(相違点なし)

2015年4月30日 (木) 10:29時点における版

説明

Quicktags APIを使用すると、WordPressのエディタのテキスト(HTML)モードで追加のボタンを含めることができます。

このページは Make WordPress Coreで提案されました。 関連Tracチケット: 16695 

WordPress Text editor buttons

使い方

QTags.addButton( id, display, arg1, arg2, access_key, title, priority, instance );

パラメータ

id
string) (必須) The html id for the button.
初期値: なし
display
string) (必須) The html value for the button.
初期値: なし
arg1
string) (必須) Either a starting tag to be inserted like "<span>" or a callback that is executed when the button is clicked.
初期値: なし
arg2
string) (optional) Ending tag like "</span>". Leave empty if tag doesn't need to be closed (i.e. "<hr />").
初期値: なし
access_key
string) (optional) Shortcut access key for the button.
初期値: なし
title
string) (optional) The html title value for the button.
初期値: なし
priority
int) (optional) A number representing the desired position of the button in the toolbar. 1 - 9 = first, 11 - 19 = second, 21 - 29 = third, etc.
初期値: なし
instance
string) (optional) Limit the button to a specific instance of Quicktags, add to all instances if not present.
初期値: なし

戻り値

(mixed) 
Null または後方互換のために必要とされるボタンオブジェクト。

// add more buttons to the html editor
function appthemes_add_quicktags() {
    if (wp_script_is('quicktags')){
?>
    <script type="text/javascript">
    QTags.addButton( 'eg_paragraph', 'p', '<p>', '</p>', 'p', 'Paragraph tag', 1 );
    QTags.addButton( 'eg_hr', 'hr', '<hr />', '', 'h', 'Horizontal rule line', 201 );
    QTags.addButton( 'eg_pre', 'pre', '<pre lang="php">', '</pre>', 'q', 'Preformatted text tag', 111 );
    </script>
<?php
    }
}
add_action( 'admin_print_footer_scripts', 'appthemes_add_quicktags' );

(Note: to avoid a Reference Error we check to see whether or not the 'quicktags' script is in use.)

The above would add HTML buttons to the default Quicktags in the Text editor. For example, the "p" button HTML would be:

<input type="button" id="qt_content_eg_paragraph" accesskey="p" class="ed_button" title="Paragraph tag" value="p">

(The ID value for each button is automatically prepended with the string 'qt_content_'.)

Here is a dump of the docblock from quicktags.js, it's pretty useful on it's own.

/**
 * Main API function for adding a button to Quicktags
 *
 * Adds qt.Button or qt.TagButton depending on the args. The first three args are always required.
 * To be able to add button(s) to Quicktags, your script should be enqueued as dependent
 * on "quicktags" and outputted in the footer. If you are echoing JS directly from PHP,
 * use add_action( 'admin_print_footer_scripts', 'output_my_js', 100 ) or add_action( 'wp_footer', 'output_my_js', 100 )
 *
 * Minimum required to add a button that calls an external function:
 *     QTags.addButton( 'my_id', 'my button', my_callback );
 *     function my_callback() { alert('yeah!'); }
 *
 * Minimum required to add a button that inserts a tag:
 *     QTags.addButton( 'my_id', 'my button', '<span>', '</span>' );
 *     QTags.addButton( 'my_id2', 'my button', '<br />' );
 */

デフォルトのクイックタグ

ここにテキストエディタ(アクセスキーの値によってソートされたテーブル)にWordPressで追加されたデフォルトQuicktagsの値です。アクセスキーとIDは一意でなければなりません。独自のボタンを追加する場合は、これらの値を使用しないでください。:

アクセスキー ID Value Tag Start Tag End
a link link <a href="' + URL + '"> </a>
b strong b <strong> </strong>
c code code <code> </code>
d del del <del datetime="' + _datetime + '"> </del>
f fullscreen fullscreen
i em i <em> </em>
l li li \t<li> </li>\n
m img img <img src="' + src + '" alt="' + alt + '" />
o ol ol <ol>\n </ol>\n\n
q block b-quote \n\n<blockquote> </blockquote>\n\n
s ins ins <ins datetime="' + _datetime + '"> </ins>
t more more <!--more-->
u ul ul <ul>\n </ul>\n\n
spell lookup
close close

(Some tag values above use variables, such as URL and _datetime, passed from functions.)

変更履歴

ソースファイル

qt.addButton() is located in wp-includes/js/quicktags.js and wp-includes/js/quicktags.min.js.

外部リソース

最新英語版: WordPress Codex » Conditional Tags最新版との差分