get_category_template() WordPress Function

The get_category_template() function in WordPress allows you to use a custom template for a specific category. This is useful if you want to change the layout or design of a particular category. To use this function, you first need to create a new template file in your theme directory. Then, you can use the get_category_template() function to load the template file for a specific category.

get_category_template() #

Retrieve path of category template in current or parent template.


Description

The hierarchy for this template looks like:

  1. category-{slug}.php
  2. category-{id}.php
  3. category.php

An example of this is:

  1. category-news.php
  2. category-2.php
  3. category.php

The template hierarchy and template path are filterable via the ‘$type_template_hierarchy’ and ‘$type_template’ dynamic hooks, where $type is ‘category’.

Top ↑

See also


Top ↑

Return

(string) Full path to category template file.


Top ↑

Source

File: wp-includes/template.php

function get_category_template() {
	$category = get_queried_object();

	$templates = array();

	if ( ! empty( $category->slug ) ) {

		$slug_decoded = urldecode( $category->slug );
		if ( $slug_decoded !== $category->slug ) {
			$templates[] = "category-{$slug_decoded}.php";
		}

		$templates[] = "category-{$category->slug}.php";
		$templates[] = "category-{$category->term_id}.php";
	}
	$templates[] = 'category.php';

	return get_query_template( 'category', $templates );
}


Top ↑

Changelog

Changelog
VersionDescription
4.7.0The decoded form of category-{slug}.php was added to the top of the template hierarchy when the category slug contains multibyte characters.
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.