is_customize_preview()


WordPressのis_customize_preview()関数は、カスタマイザーのプレビューモードで現在のリクエストが実行されているかどうかを確認するために使用されます。この関数は、カスタマイザー内でのみ特定のコードを実行したい場合に便利です。

構文

is_customize_preview();
  • bool — カスタマイザーのプレビューモードであればtrue、そうでなければfalseを返します。

例1: カスタマイザープレビュー中の特定のスタイルを適用

カスタマイザーのプレビューモード中にのみ特定のCSSスタイルを適用する例です。

<?php if ( is_customize_preview() ) { echo '<style>body { background-color: yellow; }</style>'; } ?>

例2: カスタマイザープレビュー中にメッセージを表示

カスタマイザーのプレビューモード中にのみメッセージを表示する例です。

<?php if ( is_customize_preview() ) { echo '<p>カスタマイザープレビュー中です。</p>'; } ?>

例3: カスタマイザープレビュー中に特定のスクリプトを読み込む

カスタマイザーのプレビューモード中にのみ特定のJavaScriptファイルを読み込む例です。

<?php if ( is_customize_preview() ) { wp_enqueue_script('custom-preview-script', get_template_directory_uri() . '/js/custom-preview.js'); } ?>

例4: カスタマイザープレビュー中にウィジェットを非表示にする

カスタマイザーのプレビューモード中に特定のウィジェットを非表示にする例です。

<?php if ( is_customize_preview() ) { remove_action('wp_footer', 'my_custom_widget'); } ?>

例5: カスタマイザープレビュー中に特定のショートコードを実行

カスタマイザーのプレビューモード中にのみ特定のショートコードを実行する例です。

<?php if ( is_customize_preview() ) { echo do_shortcode('[my_custom_shortcode]'); } ?>

例6: カスタマイザープレビュー中に特定のフィルターを適用

カスタマイザーのプレビューモード中にのみ特定のフィルターを適用する例です。

<?php if ( is_customize_preview() ) { add_filter('the_content', 'my_custom_content_filter'); } ?>

例7: カスタマイザープレビュー中に特定のアクションを実行

カスタマイザーのプレビューモード中にのみ特定のアクションを実行する例です。

<?php if ( is_customize_preview() ) { do_action('my_custom_preview_action'); } ?>

例8: カスタマイザープレビュー中に特定のメタデータを表示

カスタマイザーのプレビューモード中にのみ特定のメタデータを表示する例です。

<?php if ( is_customize_preview() ) { echo get_post_meta(get_the_ID(), 'my_custom_meta_key', true); } ?>

注意点

  • この関数は、カスタマイザーのプレビューモード中にのみ使用されるべきです。通常のフロントエンド表示では使用しないでください。
  • カスタマイザーのプレビューモード中に実行されるコードは、パフォーマンスに影響を与える可能性があるため、注意して使用してください。

関連機能：