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

説明

is_preview() は、投稿のプレビュー画面を表示しているかを判定する関数です。

基本構文

is_preview(): bool

引数

引数はありません。

戻り値

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

使い方(サンプル)

if ( is_preview() ) {
	// プレビュー時の処理
}

注意点

  • アクセス解析タグなどをプレビュー時に出さないために使えます。

実務での使いどころ

  • プレビュー表示のときだけ、注意書きを出すとき。
  • プレビュー時は、アクセス解析のタグを出さないとき。

よくあるミスと対処

  • カスタマイザーのプレビューと混同している。カスタマイザーは is_customize_preview()。
  • プレビューを、誰でも見られると思っている。プレビューには、ログインと編集の権限が必要。

NG例

if ( is_preview() ) {
	// カスタマイザーのプレビューのつもり
}

OK例

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

使い分け早見表

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

関連項目

is_customize_preview()、is_single()

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

コメント

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