概要
shortcode_exists 関数は、WordPress においてショートコードが登録されているかどうかを調べるために使用されます。この関数は、ショートコードを動的に生成したり、条件に応じてショートコードを表示したりする際に非常に便利です。主に以下のような機能の実装に利用されます：
- ショートコードの存在チェック
- ショートコードの動的生成
- 依存関係の管理
- プラグインの互換性チェック
- テーマのカスタマイズ
- 短縮コードのスナップショットの取得
- デバッグ情報の表示
- 管理画面での条件付き表示
構文
shortcode_exists( $tag );
パラメータ
$tag(文字列) : 存在を確認したいショートコードの名前。
戻り値
- boolean : ショートコードが存在する場合は
true、存在しない場合はfalseを返します。
関連する関数
WordPress バージョンおよびファイルパス
- 対応バージョン: 4.0 以降
- コアファイルのパス:
wp-includes/shortcodes.php
この関数のアクションでの使用可能性
| アクション名 | 使用可能性 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード 1: ショートコードの存在確認
if ( shortcode_exists( 'my_shortcode' ) ) {
echo do_shortcode( '[my_shortcode]' );
} else {
echo 'ショートコードは存在しません。';
}
このコードは、my_shortcode というショートコードが存在するか確認し、存在する場合はそれを実行します。存在しない場合はメッセージを表示します。
サンプルコード 2: ショートコードに基づいて異なるコンテンツを表示
function my_custom_function() {
if ( shortcode_exists( 'example_shortcode' ) ) {
return 'ショートコードが利用可能です。';
}
return 'ショートコードは未登録です。';
}
add_shortcode( 'custom_check', 'my_custom_function' );
このコードは custom_check というショートコードを定義し、example_shortcode が存在するかどうかをチェックして、その結果に応じたメッセージを返します。
サンプルコード 3: ショートコードのバージョン管理
function check_shortcode_version() {
if ( shortcode_exists( 'deprecated_shortcode' ) ) {
// 旧ショートコードはまだ使用されています
return '古いショートコードが優先されています。';
}
return '新しいショートコードへ移行しましょう。';
}
add_shortcode( 'check_version', 'check_shortcode_version' );
このコードは、古いショートコードの存在をチェックし、使用されているかどうかに応じてメッセージを返します。
サンプルコード 4: ショートコードの互換性を確認
function compatibility_check() {
if ( shortcode_exists( 'legacy_shortcode' ) ) {
return '互換性に問題があります。';
}
return 'すべてのショートコードは最新です。';
}
add_shortcode( 'compatibility', 'compatibility_check' );
このコードは、互換性のあるショートコードが使用されているかを確認し、問題がある場合は警告メッセージを表示します。
サンプルコード 5: ショートコードによるコンテンツの切り替え
function toggle_content() {
if ( shortcode_exists( 'toggle_shortcode' ) ) {
return 'ショートコードコンテンツはここに表示されます。';
}
return '通常のコンテンツがここに表示されます。';
}
add_shortcode( 'toggle_contents', 'toggle_content' );
このコードは、特定のショートコードが存在する場合と存在しない場合で異なるコンテンツを表示します。