is_home() WordPress Function
The is_home() function is used to check whether the current page is the home page of the site.
is_home() #
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.
See also
Return
(bool) Whether the query is for the blog homepage.
More Information
History
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 theID
of the static page assigned to the front pageget_option( 'page_for_posts' )
: returns theID
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 returntrue
is_home()
will returntrue
- If assigned, WordPress ignores the pages assigned to display the site front page or the blog posts index
- On the site front page:
- If
'page' == get_option( 'show_on_front' )
:- On the page assigned to display the site front page:
is_front_page()
will returntrue
is_home()
will returnfalse
- On the page assigned to display the blog posts index:
is_front_page()
will returnfalse
is_home()
will returntrue
- On the page assigned to display the site front page:
Notes
is_home() uses the global $wp_query
WP_Query object. is_home() isn’t usable before the ‘parse_query’ action.
Source
File: wp-includes/query.php
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(); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
1.5.0 | Introduced. |