Determines whether the query is for the front page of the site.
Description
This is for what is displayed at your site’s main URL.
Depends on the site’s "Front page displays" Reading Settings ‘show_on_front’ and ‘page_on_front’.
If you set a static page for the front page of your site, this function will return true when viewing that page.
Otherwise the same as is_home().
For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.
Source
function is_front_page() {
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_front_page();
}
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |
Example for loading a different header on the front page:
If you are using a static page as your front page, this is useful:
Usage in a Custom Function
Added to your themes functions file, this code includes the
is_front_page()
conditional tag after the function name so the content only displays on the front page.To check if any page is the current front page (for example, when you’re in a custom loop) you can use this function. It expects a page ID as argument:
Use of this function before Action
wp
will not work properly. For example, even at the Action immediately prior towp
,posts_selection
, it returnsFALSE
even when it returnsTRUE
atwp
.