is_archive() – Function | Developer.WordPress.org

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.

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

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

View all references View on Trac View on GitHub

Uses	Description
WP_Query::is_archive()`wp-includes/class-wp-query.php`	Determines whether the query is for an existing archive page.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Used by	Description
wp_get_archives()`wp-includes/general-template.php`	Displays archive links based on type and format.
wp_title()`wp-includes/general-template.php`	Displays or retrieves page title for all areas of blog.
get_body_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the body element.

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Examples
```
<?php
if(is_archive())
    // write your code here ...
?>
```
- “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 )” The above comment isn’t very clear. Readers could interperate this that “is_archive() ” does not work on custom post types. Maybe something along the lines of: “is_archive() does not accept any parameters. If you want to check if this is the archive of a specific custom post type, use is_post_type_archive( $post_type )”
  
  Lewis Self 5 years ago
Log in to add feedback

is_archive(): bool

In this article