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

説明

is_customize_preview() は、テーマカスタマイザーのプレビュー内かどうかを判定する関数です。

基本構文

is_customize_preview(): bool

引数

引数はありません。

戻り値

条件に当てはまれば true、そうでなければ false。

使い方(サンプル)

if ( is_customize_preview() ) {
	// カスタマイザーのプレビュー中
}

注意点

  • カスタマイザー専用のスクリプトを読み込むときなどに使います。

実務での使いどころ

  • カスタマイザーのプレビュー中だけ、表示を変えるとき。
  • プレビュー中に、アクセス解析のタグを出さないとき。

よくあるミスと対処

  • is_preview() と混同している。is_preview() は記事のプレビューで、これはカスタマイザーのプレビュー。
  • プレビューでだけ表示を変えて、公開後の見た目との違いに気づかない。

NG例

if ( is_preview() ) {
	// カスタマイザーの確認用のつもり
}

OK例

if ( is_customize_preview() ) {
	// カスタマイザーのプレビュー
}

使い分け早見表

やりたいこと 使うもの
カスタマイザーのプレビューか is_customize_preview()
記事のプレビューか is_preview()
管理画面か is_admin()

関連項目

is_preview()、is_admin()

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

コメント

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