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.

See also

Return

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

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 )

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

Uses

Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/class-wp-query.php: WP_Query::is_archive()

Is the query for an existing archive page?
wp-includes/functions.php: _doing_it_wrong()

Mark something as being incorrectly called.

Used By

Used By Description
wp-includes/general-template.php: wp_get_archives()

Display archive links based on type and format.
wp-includes/general-template.php: wp_title()

Display or retrieve page title for all areas of blog.
wp-includes/post-template.php: get_body_class()

Retrieves an array of the class names for the body element.

Changelog

Version Description
1.5.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_archive