is_singular() WordPress Function

The is_singular() function in WordPress is used to check if a page is a singular post type. This function returns a boolean value of true or false.

is_singular( string|string[] $post_types = '' ) #

Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).


Description

If the $post_types parameter is specified, this function will additionally check if the query is for one of the Posts Types specified.

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

Top ↑

See also


Top ↑

Parameters

$post_types

(string|string[])(Optional) Post type or array of post types to check against.

Default value: ''


Top ↑

Return

(bool) Whether the query is for an existing single post or any of the given post types.


Top ↑

Source

File: wp-includes/query.php

function is_singular( $post_types = '' ) {
	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_singular( $post_types );
}


Top ↑

Changelog

Changelog
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.