is_archive() WordPress Function

The is_archive() function is a conditional tag that is used to determine whether the current page is an archive page. An archive page is a page that displays a list of posts, either by category, tag, author, or date. The is_archive() function returns a boolean value of true or false. If the current page is an archive page, the function will return a value of true. Otherwise, it will return a value of false.

is_archive() #

Determines whether the query is for an existing archive page.


Description

Archive pages include category, tag, author, date, custom post type, and custom taxonomy based archives.

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

Top ↑

See also


Top ↑

Return

(bool) Whether the query is for an existing archive page.


Top ↑

More Information

is_archive() does not accept any parameters. If you want to check if this is the archive of a custom post type, use is_post_type_archive( $post_type )


Top ↑

Source

File: wp-includes/query.php

function is_archive() {
	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_archive();
}


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.