概要
is_front_page
関数は、WordPress において現在表示されているページがフロントページ(静的ホームページまたはブログのトップページ)であるかどうかを確認するために使用されます。この関数は、さまざまなカスタマイズや条件分岐に役立ちます。例えば、特定のスタイルやスクリプトをフロントページのみに適用したり、特定のコンテンツを表示したりする際に役立ちます。
よく使われる機能
- フロントページスタイルのカスタマイズ
- 特定のスクリプトやスタイルシートをフロントページにのみ読み込む
- フロントページには特別なウィジェットを表示する
- コンテンツの条件分岐による表示制御
- SEO対策としてフロントページ用のメタタグ設定
- ユーザー向けの特別なメッセージの表示
- 分析ツールによるトラッキングの制御
- 多言語サイトのフロントページ設定
構文
is_front_page();
パラメータ
この関数にはパラメータはありません。
戻り値
is_front_page
関数は、フロントページである場合は true
を、そうでない場合は false
を返します。
関連する関数
使用可能なバージョン
is_front_page
関数は、WordPress のバージョン 2.1 から利用可能です。
コアファイルのパス
is_front_page
関数は、wp-includes/query.php
ファイルに含まれています。
サンプルコード
サンプルコード 1
if ( is_front_page() ) {
echo '<h1>Welcome to My Front Page!</h1>';
}
このコードは、フロントページの場合に特定のメッセージを表示します。
サンプルコード 2
function custom_front_page_styles() {
if ( is_front_page() ) {
wp_enqueue_style( 'front-page-style', get_template_directory_uri() . '/css/front-page.css' );
}
}
add_action( 'wp_enqueue_scripts', 'custom_front_page_styles' );
フロントページのみに適用されるスタイルシートを読み込みます。
サンプルコード 3
if ( is_front_page() ) {
get_template_part( 'template-parts/content', 'front' );
} else {
get_template_part( 'template-parts/content', 'default' );
}
フロントページの時に特定のテンプレートパーツを読み込み、それ以外はデフォルトを読み込む機能です。
サンプルコード 4
function custom_front_page_notice() {
if ( is_front_page() ) {
echo '<div class="notice">This is an important notice for everyone visiting the front page!</div>';
}
}
add_action( 'wp_footer', 'custom_front_page_notice' );
フロントページのフッターに特別な通知を表示します。
サンプルコード 5
if ( is_front_page() ) {
query_posts( 'posts_per_page=1' );
if ( have_posts() ) {
while ( have_posts() ) {
the_post();
the_title();
}
}
}
フロントページでは最新の1件の投稿を表示するサンプルです。
この関数のアクションでの使用可能性
アクション | 使用可能性 |
---|---|
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_front_page
関数は、現在まだ非推奨または削除されたバージョンはありません。