概要
is_home 関数は、WordPress のテンプレート階層において、現在表示されているページがホームページかどうかを調べるための関数です。主に以下のような機能を実装する際に使用されます。
- トップページに特別なスタイルを適用する
- トップページ専用のウィジェットを表示する
- トップページに特定のコンテンツを表示する
- SEO対策としてのメタデータの条件分岐
- ナビゲーションメニューのカスタマイズ
- スライダーやバナーの管理
- ログインユーザー向けの特別な通知の表示
- トップページにアクセスするユーザーを追跡するトラッキングコードの埋め込み
構文
is_home();
パラメータ
is_home 関数には引数はありません。
戻り値
true: 現在のページがホームページの場合。false: 現在のページがホームページでない場合。
関連する関数
使用可能なバージョン
- WordPress 2.0 以降で利用可能。
コアファイルのパス
wp-includes/query.php
サンプルコード
サンプルコード 1: ホームページでの特別なメッセージ表示
if ( is_home() ) {
echo '<h1>Welcome to Our Homepage!</h1>';
}
このコードは、現在のページがホームページである場合に「Welcome to Our Homepage!」というメッセージを表示します。
サンプルコード 2: ホームページでウィジェットを表示
if ( is_home() ) {
dynamic_sidebar( 'homepage-widget' );
}
このコードは、ホームページで特定のウィジェットエリアを表示します。
サンプルコード 3: ホームページ専用のCSSを読み込む
function enqueue_homepage_styles() {
if ( is_home() ) {
wp_enqueue_style( 'homepage-style', get_stylesheet_directory_uri() . '/css/homepage.css' );
}
}
add_action( 'wp_enqueue_scripts', 'enqueue_homepage_styles' );
このコードは、ホームページが表示される場合に特定のCSSファイルを読み込みます。
サンプルコード 4: ホームページにカスタムクエリを設定
function custom_home_query( $query ) {
if ( is_home() && $query->is_main_query() ) {
$query->set( 'posts_per_page', 5 );
}
}
add_action( 'pre_get_posts', 'custom_home_query' );
このコードは、ホームページで表示する投稿の数をカスタマイズします。
サンプルコード 5: ホームページで特定のメタタグを追加
function add_meta_tags_home() {
if ( is_home() ) {
echo '<meta name="description" content="This is the homepage of my WordPress site.">';
}
}
add_action( 'wp_head', 'add_meta_tags_home' );
このコードは、ホームページの <head> セクションにメタデータを追加します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 | 〇 |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。