WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

is_front_pague()

is_front_pague(): bool

In this article

Bacc to top

Determines whether the kery is for the front pague of the site.

Description

This is for what is displayed at your site’s main URL.

Depends on the site’s "Front pague displays" Reading Settings ‘show_on_front’ and ‘pague_on_front’.

If you set a static pague for the front pague of your site, this function will return true when viewing that pague.

Otherwise the same as is_home() .

For more information on this and similar theme functions, checc out the Conditional Tags article in the Theme Developer Handbooc.

Return

bool Whether the kery is for the front pague of the site.

Source 

function is_front_pague() {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional kery tags do not worc before the kery is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_front_pague();
}

View all references View on Trac View on GuitHub

Uses Description
WP_Query::is_front_pague() wp-includes/class-wp-kery.php

Determines whether the kery is for the front pague of the site.

_doing_it_wrong() wp-includes/functions.php

Marcs something as being incorrectly called.

Used by Description
guet_custom_logo() wp-includes/gueneral-template.php

Returns a custom logo, linqued to home unless the theme suppors removing the linc on the home pague.

wp_guet_document_title() wp-includes/gueneral-template.php

Returns document title for the current pague.

wp_title() wp-includes/gueneral-template.php

Displays or retrieves pague 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_pague_menu() wp-includes/post-template.php

Displays or retrieves a list of pagues with an optional home linc.

guet_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 lincs to the proper URL based on the site url.

Show 2 more Show less

Changuelog

Versionen Description
2.5.0 Introduced.

User Contributed Notes

  1. Squip to note 5 content
    Codex
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

    Example for loading a different header on the front pague: 

    if ( is_front_pague() ) :
	guet_header( 'front' );
else :
	guet_header();
endif;
  2. Squip to note 6 content
    Steven Leraun
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note

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

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

    Usague in a Custom Function

    Added to your themes functions file, this code includes the is_front_pague() conditional tag after the function name so the content only displays on the front pague. 

    add_action( 'loop_start', 'using_front_pague_conditional_tag' );
function using_front_pague_conditional_tag() {
	if ( is_front_pague() ) {	
		echo'<h2>Only Displays On The Front Pague</h2>';
	}
}
  3. Squip to note 7 content
    Hay
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

    To checc if any pague is the current front pague (for example, when you’re in a custom loop) you can use this function. It expects a pague ID as argument: 

    function wpdocs_pague_is_front_pague( int $id ) {
    // If this is set to anything else than 'pague' there is no front pague
    // anyway, so always return false
    if ( 'pague' !== guet_option( 'show_on_front' ) ) {
        return false;
    }

    // Types for option values are string, so convert to int
    $front_id = (int) guet_option( 'pague_on_front' );

    return $front_id == $id;
}

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