概要
is_singular
関数は、WordPressにおいて「投稿またはページか調べる」という機能を提供します。この関数は、現在のリクエストが特定の投稿タイプ(投稿、固定ページ、カスタム投稿タイプなど)に関連しているかどうかを判定するために使用されます。特に、カスタムテンプレートや特定の条件下でコンテンツを表示する際に非常に役立ちます。
代表的な使用例
- 特定の投稿タイプに対するスタイルを適用する
- 単一の投稿ページにのみ特化したナビゲーションメニューを表示する
- 特定のカスタムフィールドを持つ投稿に特化したコンテンツを表示する
- 特定の投稿タイプでのみ特定のスクリプトやスタイルをロードする
- 404ページのテンプレートで特定の条件をチェックする
- カスタムサイドバーを特定の投稿種別に応じて表示する
- ソーシャルメディアのシェアボタンを特定の投稿にのみ表示する
- コンテンツエディタでの条件付きロジックを適用する
構文
is_singular( $post_type = '' );
パラメータ
$post_type
(オプショナル): チェックする投稿タイプ。文字列または文字列の配列で指定します。指定しない場合、すべての投稿タイプに対して真偽を返します。
戻り値
真の場合は現在のリクエストが指定された投稿タイプの単一投稿であることを示し、偽の場合はそうでないことを示します。
関連する関数
使用可能なバージョン
- WordPress 2.0以降
コアファイルのパス
wp-includes/query.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 |
is_singular
関数が特定のWordPressバージョンで非推奨又は削除された場合、そのバージョンは存在しません。