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

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

関数リファレンス/shortcode atts

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/shortcode atts」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

ユーザーがショートコードに指定した属性を、予め定義した属性と結合し、必要に応じてデフォルト値をセットします。結果は配列で、キーが予め定義された属性、値が指定された属性値を結合したものになります。

使い方

<?php shortcode_atts( $pairs , $atts, $shortcode ); ?>

パラメータ

$pairs
配列) (必須) サポートするすべての属性の名前とデフォルト値
初期値: なし
$atts
配列) (必須) ユーザーがショートコードタグに指定した属性
初期値: なし
$shortcode
文字列) (オプションshortcode_atts_{$shortcode} フィルターに使われるショートコード名。これを指定すると、他のコードが属性をフィルターするために shortcode_atts_{$shortcode} フィルターを使用できます。このパラメータはオプションですが、互換性を最大にするため常に含めるべきです。
初期値: なし

戻り値

(配列) 
結合されフィルターされた属性のリスト。

用例

function bartag_func( $atts ) {
	$atts = shortcode_atts(
		array(
			'foo' => 'no foo',
			'bar' => 'default bar',
		), $atts, 'bartag' );

	return 'bartag: ' . $atts['foo'] . ' ' . $atts['bar'];
}
add_shortcode( 'bartag', 'bartag_func' );

[bartag foo="koala" bar="bears"] は次のように出力します:
bartag: koala bears

[bartag foo="koala"] は次のように出力します:
bartag: koala default bar

上記の例は "[bartag]" ショートコードを作ります。これは 2 つの属性をサポートします: [bartag foo="something" bar="something else"]。どちらの属性もオプションで、指定されなければデフォルト値になります。

参考

$pairs はサポートするすべての属性を入れ、リストとして与える必要があります。返される属性は $pairs リストにある属性のみが含まれます。

もし $atts リストにサポート外の属性があると、それらは無視され、返されるリストから削除されます。

変更履歴

ソースファイル

shortcode_atts()wp-includes/shortcodes.php にあります。

wp_parse_args()


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


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


最新英語版: WordPress Codex » Function Reference/shortcode_atts最新版との差分