WEB制作のための情報サイト / unazuki Library

基本構文と使い方（引数・実行結果）

基本構文

ショートコードが実行された文字列を返します。テンプレートファイル内でショートコードを呼び出したいときに使えます。

do_shortcode($content,$ignore_html)

do_shortcode($content,$ignore_html)

引数

実行結果

戻り値（返す値）：ショートコードが実行された文字列
※表示するにはechoします。

例１．ショートコードを実行する１

例えば、下記のようにfunctions.phpで、add_shortcode()を使ってショートコードmyshortcodeが追加されているとします。

function my_text_shortcode() {
	return '<div class="my-text">ショートコードで出力するテキスト</div>';
}
add_shortcode('myshortcode', 'my_text_shortcode');

function my_text_shortcode() {
	return '<div class="my-text">ショートコードで出力するテキスト</div>';
}
add_shortcode('myshortcode', 'my_text_shortcode');

下記コードをテンプレートファイルの任意の場所に記述することで、ショートコードmyshortcodeを呼び出します。

<?php echo do_shortcode('[myshortcode]') ?>

<?php echo do_shortcode('[myshortcode]') ?>

実行した結果、以下のHTMLが出力されます。

<div class="my-text">ショートコードで出力するテキスト</div>

<div class="my-text">ショートコードで出力するテキスト</div>

例２．ショートコードを実行する２

例１同様にショートコードmyshortcodeがfunctions.phpで追加されているとします。下記コード例では、第１引数の中からショートコードのタグを探し、myshortcode を実行して返ってきた文字列をsectionタグに埋め込んで返します。つまり第１引数には必ずしもタグ名だけを渡さないといけないわけではありません。渡された値からタグ名を検索して、ショートコードが存在すればそのタブ部分を変換した結果を返します。

do_shortcode('<section>[myshortcode]</section>')

do_shortcode('<section>[myshortcode]</section>')

実行した結果、以下のHTMLが出力されます。

<section><div class="my-text">ショートコードで出力するテキスト</div></section>

<section><div class="my-text">ショートコードで出力するテキスト</div></section>

関連するテンプレートタグ