shortcode_exists() の使い方|説明・引数・注意点

説明

shortcode_exists() は、指定したショートコードが登録されているかを判定する関数です。

基本構文

shortcode_exists( string $tag ): bool

引数

  • $tag:ショートコードの名前

戻り値

登録されていれば true。

使い方(サンプル)

if ( shortcode_exists( 'gallery' ) ) {
	// 登録済み
}

注意点

  • プラグインが有効かどうかの目安に使えます。

実務での使いどころ

  • ショートコードが、使える状態かを、確認してから、使うとき(プラグインが、無効なとき、[タグ] の文字が、そのまま出るのを防ぐ)。

よくあるミスと対処

  • 登録されるより前に、判定している。init フックより前では、false になる。
  • 別のプラグインの、ショートコードの有無で、処理を分けているが、登録のタイミングを、考えていない。

NG例

if ( shortcode_exists( 'contact' ) ) { // init より前では、false
	// ...
}

OK例

add_action( 'init', function () {
	if ( shortcode_exists( 'contact' ) ) {
		// ...
	}
}, 20 );

使い分け早見表

関数 役割
shortcode_exists() ショートコードが、登録されているかを確認する
has_shortcode() 文字列に、ショートコードが含まれるかを確認する
do_shortcode() ショートコードを、実行する

関連項目

add_shortcode()、has_shortcode()

公式リファレンス:shortcode_exists() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました