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

概要

is_preview関数は、要求がプレビューかどうかを調べるための関数です。この関数は、主に以下のような機能を実装する際に使用されることが多いです。

1. 投稿やページのプレビュー表示
2. 編集者や管理者向けのプレビューリンクの生成
3. プレビュー状態での特定デザインの適用
4. 特定のプラグインやテーマのプレビューコントロール
5. フィルタリングされたコンテンツの条件分岐
6. プレビュー時のみ異なるメタデータを表示
7. テスト用コンテンツに対する条件付きロジック実装
8. 管理画面からの権限ベース表示制御

構文

is_preview();

パラメータ

この関数はパラメータを持ちません。

戻り値

is_preview関数は、要求がプレビューである場合にtrueを、それ以外はfalseを返します。

関連する関数

• is_single
• is_page
• is_archive
• is_home
• is_front_page

使用可能なバージョン

この関数は、WordPress 2.0.0以降のバージョンで使用可能です。

コアファイルのパス

is_preview関数は、wp-includes/query.phpファイルに含まれています。

サンプルコード

サンプル1: 投稿プレビューのチェック

if ( is_preview() ) {
    echo '<p>これはプレビュー表示です。</p>';
}

このサンプルコードは、現在のリクエストがプレビューである場合、「これはプレビュー表示です。」というメッセージを表示します。

サンプル2: プレビュー特化のスタイルを適用

if ( is_preview() ) {
    echo '<link rel="stylesheet" href="path/to/preview.css" />';
}

このサンプルコードは、プレビューで表示される際に特別なCSSファイルを読み込むために使用されます。

サンプル3: プレビューのみ特定のメタデータを表示

if ( is_preview() ) {
    $meta_value = get_post_meta( get_the_ID(), 'custom_meta', true );
    echo '<p>カスタムメタ: ' . esc_html( $meta_value ) . '</p>';
}

このサンプルコードは、プレビュー時にのみ特定のカスタムメタデータを表示する例です。

サンプル4: リンクの動的生成

if ( is_preview() ) {
    echo '<a href="' . esc_url( get_permalink() ) . '">この投稿をプレビューする</a>';
}

このサンプルコードは、プレビュー中に、現在の投稿のプレビューリンクを動的に生成して表示します。

サンプル5: 特定のレイアウトをプレビューに適用

if ( is_preview() ) {
    add_filter( 'the_content', 'custom_preview_layout' );
}
function custom_preview_layout( $content ) {
    return '<div class="preview-layout">' . $content . '</div>';
}

このサンプルコードでは、プレビューの場合に特定のレイアウトを適用するフィルターを追加しています。

この関数のアクションでの使用可能性

アクション名	使用可能性
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

非推奨または削除されたバージョン

この関数は非推奨または削除されたバージョンはありません。