ワードプレスのis_customize_preview関数の使用方法・解説

概要

is_customize_preview 関数は、ワードプレスのテーマカスタマイザーのプレビューかどうかを調べるための関数です。この関数を利用すると、テーマやプラグインがカスタマイザー環境で動作しているかを確認でき、通常のフロントエンドとは異なる動作を実装できます。以下は、is_customize_preview 関数がよく使われる機能の例です。

1. カスタマイザーでのライブプレビューをサポートするためのカスタムスタイルの追加
2. カスタマイザー内で専用のスクリプトやスタイルを読み込む
3. 特定のウィジェット設定の動作をカスタマイズする
4. カスタマイザーでのオプションが変更された際のリアルタイムフィードバックを提供
5. カスタマイザー中に特有の設定ページを表示する
6. プレビュー中のコンテンツに特別な装飾やスタイルを適用する
7. 特定の条件下でのカスタマイズを防ぐ
8. デバッグ情報を表示しやすくするための処理

構文

is_customize_preview();

パラメータ

この関数は、パラメータを受け取らず、単独で使用します。

戻り値

• true または false：カスタマイザーのプレビュー中の場合は true、それ以外は false を返します。

関連する関数

• customize_register
• get_theme_mod
• wp_customize

バージョン情報

is_customize_preview 関数は、ワードプレス 3.4.0 以降で使用可能です。

コアファイルのパス

この関数は、wp-includes/theme.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. カスタムスタイルの追加

   function my_customize_preview_styles() {
      if ( is_customize_preview() ) {
          wp_enqueue_style( 'my-custom-style', get_template_directory_uri() . '/css/customizer.css' );
      }
   }
   add_action( 'wp_enqueue_scripts', 'my_customize_preview_styles' );
   

   説明：カスタマイザーのプレビュー中に特定のスタイルシートを読み込みます。

2. カスタムスクリプトの読み込み

   function my_customize_preview_scripts() {
      if ( is_customize_preview() ) {
          wp_enqueue_script( 'my-custom-script', get_template_directory_uri() . '/js/customizer.js', array( 'jquery' ), null, true );
      }
   }
   add_action( 'wp_enqueue_scripts', 'my_customize_preview_scripts' );
   

   説明：カスタマイザーのプレビュー中に特定のスクリプトを読み込みます。

3. カスタマイザー設定の取得

   if ( is_customize_preview() ) {
      $color = get_theme_mod( 'header_color', '#ffffff' );
   }
   

   説明：カスタマイザーのプレビュー中にヘッダーの色設定を取得します。

4. 特定の条件でのカスタマイザーの制御

   function my_customizer_conditions( $wp_customize ) {
      if ( ! is_customize_preview() ) {
          $wp_customize->remove_section( 'some_section' );
      }
   }
   add_action( 'customize_register', 'my_customizer_conditions' );
   

   説明：カスタマイザーのプレビューでない場合、特定のセクションを削除します。

5. ライブプレビューのデバッグ

   function my_customizer_debug() {
      if ( is_customize_preview() ) {
          echo '<pre>' . print_r( get_theme_mods(), true ) . '</pre>';
      }
   }
   add_action( 'wp_footer', 'my_customizer_debug' );
   

   説明：カスタマイザーのプレビュー中に、テーマのすべての設定をデバッグ表示します。

以上が、is_customize_preview 関数の詳しい解説とサンプルコードです。使用する際の参考にしてください。