is_singular

Advertisement

Summery Summery

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

Syntax Syntax

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

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

Parameters Parameters

$post_types

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

Default value: ''

Return Return

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

Source 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 );

Advertisement

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

See also See also

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.