ショートコードが実行された文字列を返します。テンプレートファイル内でショートコードを呼び出したいときに使えます。
do_shortcode($content,$ignore_html)| 引数 | 必須/任意 | 引数に指定するもの |
|---|---|---|
| 第1引数 $content | 必須 | ショートコードのタグ名を含む文字列渡された値からタグ名を検索して、ショートコードが存在すればその値を変換した結果を返します。 ※詳しくは実行結果の例2参照。 |
| 第2引数 $ignore_html | 任意 | HTML内のショートコードを実行しないならture、するならfalse初期値: false |
戻り値(返す値):ショートコードが実行された文字列
※表示するにはechoします。
例えば、下記のようにfunctions.phpで、add_shortcode()を使ってショートコードmyshortcodeが追加されているとします。
function my_text_shortcode() {
return '<div class="my-text">ショートコードで出力するテキスト</div>';
}
add_shortcode('myshortcode', 'my_text_shortcode');下記コードをテンプレートファイルの任意の場所に記述することで、ショートコードmyshortcodeを呼び出します。
<?php echo do_shortcode('[myshortcode]') ?>実行した結果、以下のHTMLが出力されます。
<div class="my-text">ショートコードで出力するテキスト</div>例1同様にショートコードmyshortcodeがfunctions.phpで追加されているとします。下記コード例では、第1引数の中からショートコードのタグを探し、myshortcode を実行して返ってきた文字列をsectionタグに埋め込んで返します。つまり第1引数には必ずしもタグ名だけを渡さないといけないわけではありません。渡された値からタグ名を検索して、ショートコードが存在すればそのタブ部分を変換した結果を返します。
do_shortcode('<section>[myshortcode]</section>')実行した結果、以下のHTMLが出力されます。
<section><div class="my-text">ショートコードで出力するテキスト</div></section>【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。
【引数について】
※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。