is_archive(): bool

Description

Return

bool

Whether the query is for an existing archive page.

Uses · 2

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 9

• get_body_class()Retrieves an array of the class names for the body element.
• render_block_core_query_title()Renders the `core/query-title` block on the server.
• twentyfourteen_body_classes()Extends the default WordPress body classes.
• twentyseventeen_body_classes()Adds custom classes to the array of body classes.
• twentyseventeen_content_image_sizes_attr()Adds custom image sizes attribute to enhance responsive image functionality for content images.
• twentyseventeen_is_view_with_layout_option()Returns whether we're on a view that supports a one or two column layout.
• twentyseventeen_post_thumbnail_sizes_attr()Adds custom image sizes attribute to enhance responsive image functionality for post thumbnails.
• wp_get_archives()Displays archive links based on type and format.
• wp_title()Displays or retrieves page title for all areas of blog.

Source

View on Trac ↗View on GitHub ↗

161function is_archive() {162	global $wp_query;163 164	if ( ! isset( $wp_query ) ) {165		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );166		return false;167	}168 169	return $wp_query->is_archive();170}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.