is_home()

💡 云策文档标注

概述

is_home() 是 WordPress 的条件标签函数，用于判断当前查询是否为博客主页（即文章索引页）。其行为依赖于“阅读设置”中的“首页显示”选项，区分静态首页和博客文章页。

关键要点

is_home() 返回布尔值，表示查询是否为博客主页（文章索引页）。
与 is_front_page() 区分：is_home() 针对博客文章索引，is_front_page() 针对网站首页，两者可能重叠或分离，取决于“show_on_front”选项设置。
依赖于全局 $wp_query 对象，不能在“parse_query”动作前使用，否则会触发 _doing_it_wrong() 警告。
行为受选项值影响：get_option('show_on_front')（'posts' 或 'page'）、get_option('page_on_front')（静态首页页面ID）、get_option('page_for_posts')（博客文章页页面ID）。

代码示例

if ( is_home() ) {
    // 这是博客文章索引页
    get_sidebar( 'blog' );
} else {
    // 这不是博客文章索引页
    get_sidebar();
}

注意事项

在 WordPress 2.1 引入静态首页功能后，博客文章索引和网站首页被视为不同的查询上下文。
使用前需确保查询已运行，避免在早期钩子中调用。

📄 原文内容

Determines whether the query is for the blog homepage.

Description

The blog homepage is the page that shows the time-based blog content of the site.

is_home() is dependent on the site’s “Front page displays” Reading Settings ‘show_on_front’ and ‘page_for_posts’.

If a static page is set for the front page of the site, this function will return true only on the page you set as the “Posts page”.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Return

bool Whether the query is for the blog homepage.

Since WordPress 2.1, when the static front page functionality was introduced, the blog posts index and site front page have been treated as two different query contexts, with is_home() applying to the blog posts index, and is_front_page() applying to the site front page.

Usage

Be careful not to confuse the two query conditionals:

On the site front page, is_front_page() will always return true, regardless of whether the site front page displays the blog posts index or a static page.
On the blog posts index, is_home() will always return true, regardless of whether the blog posts index is displayed on the site front page or a separate page.

Whether is_home() or is_front_page() return true or false depends on the values of certain option values:

get_option( 'show_on_front' ): returns either 'posts' or 'page'
get_option( 'page_on_front' ): returns the ID of the static page assigned to the front page
get_option( 'page_for_posts' ): returns the ID of the static page assigned to the blog posts index (posts page)

When using these query conditionals:

If 'posts' == get_option( 'show_on_front' ):
- On the site front page:
  - is_front_page() will return true
  - is_home() will return true
- If assigned, WordPress ignores the pages assigned to display the site front page or the blog posts index
If 'page' == get_option( 'show_on_front' ):
- On the page assigned to display the site front page:
  - is_front_page() will return true
  - is_home() will return false
- On the page assigned to display the blog posts index:
  - is_front_page() will return false
  - is_home() will return true

Notes

is_home() uses the global $wp_query WP_Query object. is_home() isn’t usable before the ‘parse_query’ action.

Source

function is_home() {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_home();
}

View all references View on Trac View on GitHub

Uses	Description
WP_Query::is_home()`wp-includes/class-wp-query.php`	Determines whether the query is for the blog homepage.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Show 1 more Show less

Used by	Description
get_custom_logo()`wp-includes/general-template.php`	Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
wp_get_document_title()`wp-includes/general-template.php`	Returns document title for the current page.
wp_title()`wp-includes/general-template.php`	Displays or retrieves page title for all areas of blog.
WP::handle_404()`wp-includes/class-wp.php`	Set the Headers for 404, if nothing is found for requested URL.
get_post_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
get_body_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the body element.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.

Show 2 more Show less

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 2 content

znowebdev

11 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
The following example can be used in your sidebar to display different content when displaying the blog posts index.
```
if ( is_home() ) {
    // This is the blog posts index
    get_sidebar( 'blog' );
} else {
    // This is not the blog posts index
    get_sidebar();
}
```
Log in to add feedback

云策 WordPress 开发者社区

函数文档