wordpress / latest / classes / wp_query / is_front_page.html

WP_Query::is_front_page(): bool

Is the query 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 WP_Query::is_home()

Return

bool Whether the query is for the front page of the site.

Source

File: wp-includes/class-wp-query.php. View all references

public function is_front_page() {
	// Most likely case.
	if ( 'posts' === get_option( 'show_on_front' ) && $this->is_home() ) {
		return true;
	} elseif ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' )
		&& $this->is_page( get_option( 'page_on_front' ) )
	) {
		return true;
	} else {
		return false;
	}
}

Uses

Uses Description

Used By

Used By Description

Changelog

Version Description
3.1.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_query/is_front_page