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

最終更新 : 2020年04月02日 11:21



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。