is_front_page()

Determines whether the query is for the front page of the site.


Description 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.


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-includes/query.php

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();
}


Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Example for loading a different header on the front page:

    if ( is_front_page() ) :
    	get_header( 'front' );
    else :
    	get_header();
    endif;
    
  2. Skip to note 2 content
    Contributed by stevenlinx

    If you are using a static page as your front page, this is useful:

    <title><?php bloginfo('name'); ?> &raquo; <?php is_front_page() ? bloginfo('description') : wp_title(''); ?></title>

    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.

    add_action( 'loop_start', 'using_front_page_conditional_tag' );
    function using_front_page_conditional_tag() {
    	if ( is_front_page() ) {	
    		echo'<h2>Only Displays On The Front Page</h2>';
    	}
    }
    

You must log in before being able to contribute a note or feedback.