On this page
is_front_page(): bool
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 @see is_home()
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 front page of the site.
Source
File: wp-includes/query.php. View all references
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();
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Query::is_front_page() wp-includes/class-wp-query.php | Is the query for the front page of the site? |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| _doing_it_wrong() wp-includes/functions.php | Marks something as being incorrectly called. |
Used By
| 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_menu_item_classes_by_context() wp-includes/nav-menu-template.php | Adds the class property classes for the current context, if applicable. |
| wp_page_menu() wp-includes/post-template.php | Displays or retrieves a list of pages with an optional home link. |
| 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. |
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_front_page