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

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

関数リファレンス/add shortcode

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年7月9日 (金) 23:16時点におけるAbecchi (トーク | 投稿記録)による版 (日本語へ翻訳)

移動先: 案内検索

説明

ショートコードタグへのフックを追加します。

使用法

 <?php add_shortcode( $tag , $func ); ?>

パラメータ

$tag
string) (必須) 記事の本文より検索する、ショートコードタグ
初期値: なし
$func
callable) (必須) ショートコードが見つかったときに実行されるフック
初期値: なし

戻り値

(なし)

ショートコードタグの最も簡単な例 : [footag foo="bar"]

function footag_func($atts) {
     return "foo = {$atts[foo]}";
}
add_shortcode('footag', 'footag_func');

デフォルトの属性を使ったより良い例 : [bartag foo="bar"]

function bartag_func($atts) {
     extract(shortcode_atts(array(
	      'foo' => 'no foo',
	      'baz' => 'default baz',
     ), $atts));
     return "foo = {$foo}";
}
add_shortcode('bartag', 'bartag_func');

コンテントを囲んだ場合の例 : [baztag]content[/baztag]

function baztag_func($atts, $content=) {
     return "content = $content";
}
add_shortcode('baztag', 'baztag_func');

備考

各ショートコードには、一つだけフックを定義することができます。そのため、他のプラグインが同じショートコードを持っていると、他のプラグインによってフックが上書きされるか、または他のプラグインのフックを上書きする事態になります。どちらになるかは、インクルードの順番または実行の順番に左右されます。

ショートコードの属性名は常に英小文字に変換されてハンドラ関数に渡されます。属性値についてはそのような変換はありません。

更新履歴

2.5より

ソースファイル

add_shortcode() は、 wp-includes/shortcodes.phpにあります。

関連

ショートコード: do_shortcode(), add_shortcode(), remove_shortcode(), remove_all_shortcodes(), shortcode_atts(), strip_shortcodes(), shortcode_exists(), has_shortcode(), get_shortcode_regex(), wp_audio_shortcode(), wp_video_shortcode(), フィルター no_texturize_shortcodes /en


関数リファレンステンプレートタグ目次もご覧ください。