is_category( int|string|int[]|string[] $category = '' )

Determines whether the query is for an existing category archive page.


Description Description

If the $category parameter is specified, this function will additionally check if the query is for one of the categories specified.

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


Top ↑

Parameters Parameters

$category

(int|string|int[]|string[]) (Optional) Category ID, name, slug, or array of such to check against.

Default value: ''


Top ↑

Return Return

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


Top ↑

More Information More Information


Top ↑

Source Source

File: wp-includes/query.php

function is_category( $category = '' ) {
	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_category( $category );
}


Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Examples

    is_category();
    // When any Category archive page is being displayed.
    
    is_category( '9' );
    // When the archive page for Category 9 is being displayed.
    
    is_category( 'Stinky Cheeses' );
    // When the archive page for the Category with Name "Stinky Cheeses" is being displayed.
    
    is_category( 'blue-cheese' );
    // When the archive page for the Category with Category Slug "blue-cheese" is being displayed.
    
    is_category( array( 9, 'blue-cheese', 'Stinky Cheeses' ) );
    // Returns true when the category of posts being displayed is either term_ID 9,
    // or slug "blue-cheese", or name "Stinky Cheeses".
    // Note: the array ability was added in version 2.5.
    
    

You must log in before being able to contribute a note or feedback.