do_shortcode

説明

string function do_shortcode( string $content [ , bool $ignore_html = false ] )
文字列に含まれるショートコードを変換する。

パラメータ

  • $content
    投稿記事などの文字列。
  • $ignore_html
    [4.2.3]HTML要素内のショートコードを実行しない場合はtrueを、実行する場合はfalseを指定(省略時はfalse)。

返り値

ショートコードが変換された文字列を返す。

注意

このdo_shortcode関数は、 the_content関数のフィルターとして使用されており、投稿記事を表示する際に自動的に実行されている。ショートコードは投稿記事以外でも使用でき、 add_filter関数を使用するか、テーマやプラグイン内で実行することで、任意の文字列を対象にショートコードを変換することができる。

また囲み型ショートコードでそのコンテントの中にショートコードを含める(ショーコードが入れ子になる)場合には、ショートコード関数の返り値を返す直前で本関数を呼び出す。

function shortcode_example_func( $atts, $content='' ) {

	// $contentを適宜処理

	return do_shortcode( $content );
}
add_shortcode( 'exp', 'shortcode_example_func' );

[4.2.3]HTML要素(コメントを除く)内のショートコードを先に実行する。
[4.2.3]ショートコードの実行結果を返す前に無効なショートコードのアンエスケープ処理を行う。


使用例

  • ショートコードを変換する。
    <?php $decoded = do_shortcode( $content ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/shortcodes.php

最終更新 : 2018年05月27日 10:51



お勧め

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

WordCamp Tokyo 2013(2013年9月14日 更新)

本日開催された「WordCamp Tokyo 2013」に行ってきました。昨年と同様、会場は大田区産業プラザで、PHPカンファレンスと共催でしたね。

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

Login rebuilder 2.4.0の新機能を紹介(2018年5月27日 更新)

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ(author page)の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。