WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "Template Tags/wp list categories"

(update to 3.4)
(Fixed markup, see http://core.trac.wordpress.org/ticket/21343)
Line 18: Line 18:
 
===Default Usage===
 
===Default Usage===
   
%%%<?php $args = array(
+
<pre>
  +
<?php $args = array(
 
'show_option_all' => '',
 
'show_option_all' => '',
 
'orderby' => 'name',
 
'orderby' => 'name',
Line 35: Line 35:
 
'hierarchical' => true,
 
'hierarchical' => true,
 
'title_li' => __( 'Categories' ),
 
'title_li' => __( 'Categories' ),
'show_option_none' => __('No categories'),
+
'show_option_none' => __('No categories'),
'number' => NULL,
+
'number' => null,
 
'echo' => 1,
 
'echo' => 1,
 
'depth' => 0,
 
'depth' => 0,
Line 42: Line 42:
 
'pad_counts' => 0,
 
'pad_counts' => 0,
 
'taxonomy' => 'category',
 
'taxonomy' => 'category',
'walker' => 'Walker_Category' ); ?>%%%
+
'walker' => 'Walker_Category'
  +
); ?>
  +
</pre>
   
 
By default, the usage shows:
 
By default, the usage shows:

Revision as of 07:11, 23 July 2012

Description

Displays a list of Categories as links. When a Category link is clicked, all the posts in that Category will display on a Category Page using the appropriate Category Template dictated by the Template Hierarchy rules.

NOTE: wp_list_categories() works in much the same way as the two template tags replaced in WordPress 2.1, list_cats() and wp_list_cats() (both deprecated).

If you need a function that does not format the results, try get_categories()

Usage

 <?php wp_list_categories$args ); ?> 

Default Usage

<?php $args = array(
	'show_option_all'    => '',
	'orderby'            => 'name',
	'order'              => 'ASC',
	'style'              => 'list',
	'show_count'         => 0,
	'hide_empty'         => 1,
	'use_desc_for_title' => 1,
	'child_of'           => 0,
	'feed'               => '',
	'feed_type'          => '',
	'feed_image'         => '',
	'exclude'            => '',
	'exclude_tree'       => '',
	'include'            => '',
	'hierarchical'       => true,
	'title_li'           => __( 'Categories' ),
	'show_option_none'   => __('No categories'),
	'number'             => null,
	'echo'               => 1,
	'depth'              => 0,
	'current_category'   => 0,
	'pad_counts'         => 0,
	'taxonomy'           => 'category',
	'walker'             => 'Walker_Category'
); ?>

By default, the usage shows:

  • No link to all categories
  • Sorts the list of Categories by the Category name in ascending order
  • Displayed in an unordered list style
  • Does not show the post count
  • Displays only Categories with posts
  • Sets the title attribute to the Category Description
  • Is not restricted to the child_of any Category
  • No feed or feed image used
  • Does not exclude any Category and includes all Categories
  • Displays the active Category with the CSS Class-Suffix ' current-cat'
  • Shows the Categories in hierarchical indented fashion
  • Display Category as the heading over the list
  • No SQL LIMIT is imposed ('number' => 0 is not shown above)
  • Displays (echos) the categories
  • No limit to depth
  • All categories.
  • The list is rendered using the Walker_Category class

Parameters

show_option_all 
(string) A non-blank value causes the display of a link to all categories if the style is set to list. The default value is not to display a link to all.
orderby 
(string) Sort categories alphabetically, by unique Category ID, or by the count of posts in that Category. The default is sort by category name. Valid values:
  • ID - Default
  • name
  • slug
  • count
  • term_group
order 
(string) Sort order for categories (either ascending or descending). The default is ascending. Valid values:
  • ASC - Default
  • DESC
style 
(string) Style to display the categories list in. A value of list displays the categories as list items while none generates no special display method (the list items are separated by <br> tags). The default setting is list (creates list items for an unordered list). See the markup section for more. Valid values:
  • list - Default
  • none
show_count 
(boolean) Toggles the display of the current count of posts in each category. The default is false (do not show post counts). Valid values:
  • 1 (True)
  • 0 (False) - Default
hide_empty 
(boolean) Toggles the display of categories with no posts. The default is true (hide empty categories). Valid values:
  • 1 (True) - Default
  • 0 (False)
use_desc_for_title 
(boolean) Sets whether a category's description is inserted into the title attribute of the links created (i.e. <a title="<em>Category Description</em>" href="...). The default is true (category descriptions will be inserted). Valid values:
  • 1 (True) - Default
  • 0 (False)
child_of 
(integer) Only display categories that are children of the category identified by this parameter. There is no default for this parameter.
feed 
(string) Display a link to each category's rss-2 feed and set the link text to display. The default is no text and no feed displayed.
feed_type 
(string)
feed_image 
(string) Set a URI for an image (usually an rss feed icon) to act as a link to each categories' rss-2 feed. This parameter overrides the feed parameter. There is no default for this parameter.
exclude 
(string) Exclude one or more categories from the results. This parameter takes a comma-separated list of categories by unique ID, in ascending order. See the example. The child_of parameter is automatically set to false.
exclude_tree 
(string) Exclude category-tree from the results. This parameter added at Version 2.7.1
include 
(string) Only include the categories detailed in a comma-separated list by unique ID, in ascending order. See the example.
hierarchical 
(boolean) Display sub-categories as inner list items (below the parent list item) or inline. The default is true (display sub-categories below the parent list item). Valid values:
  • 1 (True) - Default
  • 0 (False)
title_li 
(string) Set the title and style of the outer list item. Defaults to "Categories". If present but empty, the outer list item will not be displayed. See below for examples.
number 
(integer) Sets the number of Categories to display. This causes the SQL LIMIT value to be defined. Default to no LIMIT.
echo 
(boolean) Show the result or keep it in a variable. The default is true (display the categories organized). This parameter added at Version 2.3 Valid values:
  • 1 (True) - Default
  • 0 (False)
depth 
(integer) This parameter controls how many levels in the hierarchy of Categories are to be included in the list of Categories. The default value is 0 (display all Categories and their children). This parameter added at Version 2.5
  • 0 - All Categories and child Categories (Default).
  • -1 - All Categories displayed in flat (no indent) form (overrides hierarchical).
  • 1 - Show only top level Categories
  • n - Value of n (some number) specifies the depth (or level) to descend in displaying Categories
current_category 
(integer) Allows you to force the "current-cat" to appear on uses of wp_list_categories that are not on category archive pages. Normally, the current-cat is set only on category archive pages. If you have another use for it, or want to force it to highlight a different category, this overrides what the function thinks the "current" category is. This parameter added at Version 2.6
pad_counts 
(boolean) Calculates link or post counts by including items from child categories. If show_counts and hierarchical are true this is automatically set to true. This parameter added at Version 2.9 Valid values:
  • 1 (true)
  • 0 (false) - default
taxonomy 
(string) Taxonomy to return.

This parameter added at Version 3.0 Valid values:

  • category - default
  • taxonomy - or any registered taxonomy
walker 
(object) Walker class to render the list with. Valid values:
  • object - an instance of a class that extends either Walker_Category or Walker

Examples

Include or Exclude Categories

To sort categories alphabetically and include only the categories with IDs of 16, 3, 9 and 5, you could write the following code:

<ul>
<?php wp_list_categories('orderby=name&include=3,5,9,16'); ?> 
</ul>

The following example displays category links sorted by name, shows the number of posts for each category, and excludes the category with the ID of 10 from the list.

<ul>
<?php wp_list_categories('orderby=name&show_count=1&exclude=10'); ?> 
</ul>

Display or Hide the List Heading

The title_li parameter sets or hides a title or heading for the category list generated by wp_list_categories. It defaults to '(__('Categories')', i.e. it displays the word "Categories" as the list's heading. If the parameter is set to a null or empty value, no heading is displayed. The following example code excludes categories with IDs 4 and 7 and hides the list heading:

<ul>
<?php wp_list_categories('exclude=4,7&title_li='); ?>
</ul>

In the following example, only Categories with IDs 9, 5, and 23 are included in the list and the heading text has been changed to the word "Poetry", with a heading style of <h2>:

<ul>
<?php wp_list_categories('include=5,9,23&title_li=<h2>' . __('Poetry') . '</h2>' ); ?> 
</ul>

Only Show Children of a Category

The following example code generates category links, sorted by ID, only for the children of the category with ID 8; it shows the number of posts per category and hides category descriptions from the title attribute of the generated links. Note: If there are no posts in a parent Category, the parent Category will not display.

<ul> 
<?php wp_list_categories('orderby=id&show_count=1&use_desc_for_title=0&child_of=8'); ?>
</ul>

Remove Parentheses from Category Counts

When show_count=1, each category count is surrounded by parentheses. In order to remove the parentheses without modifying core WordPress files, use the following code.

<?php
$variable = wp_list_categories('echo=0&show_count=1&title_li=<h2>Categories</h2>');
$variable = preg_replace('~\((\d+)\)(?=\s*+<)~', '$1', $variable);
echo $variable;
?>

Display Categories with RSS Feed Links

The following example generates Category links sorted by name, shows the number of posts per Category, and displays links to the RSS feed for each Category.

<ul>
<?php wp_list_categories('orderby=name&show_count=1&feed=RSS'); ?>
</ul>

To replace the rss link with a feed icon, you could write:

<ul>
<?php wp_list_categories('orderby=name&show_count=1&feed_image=/images/rss.gif'); ?>
</ul>

Display Terms in a custom taxonomy

With Version 3.0 the taxonomy parameter was added to enable wp_list_categories() function to list Custom Taxonomies. This example list the terms in the taxonomy genre:

<?php 
//list terms in a given taxonomy using wp_list_categories (also useful as a widget if using a PHP Code plugin)

$taxonomy     = 'genre';
$orderby      = 'name'; 
$show_count   = 0;      // 1 for yes, 0 for no
$pad_counts   = 0;      // 1 for yes, 0 for no
$hierarchical = 1;      // 1 for yes, 0 for no
$title        = '';

$args = array(
  'taxonomy'     => $taxonomy,
  'orderby'      => $orderby,
  'show_count'   => $show_count,
  'pad_counts'   => $pad_counts,
  'hierarchical' => $hierarchical,
  'title_li'     => $title
);
?>

<ul>
<?php wp_list_categories( $args ); ?>
</ul>

Markup and Styling of Category Lists

By default, wp_list_categories() generates nested unordered lists (ul) within a single list item (li) titled "Categories".

You can remove the outermost item and list by setting the title_li parameter to an empty string. You'll need to wrap the output in an ordered list (ol) or unordered list yourself (see the examples below). If you don't want list output at all, set the style parameter to none.

You can style the output with these CSS selectors :

 li.categories { ... }  /* outermost list item */
 li.cat-item { ... }
 li.cat-item-7 { ... }  /* category ID #7, etc */
 li.current-cat { ... }
 li.current-cat-parent { ... }
 ul.children { ... }

Changelog

  • Since: 2.1.0
  • 2.3.0 : Added the echo parameter.
  • 2.5.0 : Added the depth parameter.
  • 2.6.0 : Added the current_category parameter.
  • 2.7.1 : Added the exclude_tree parameter.
  • 2.9.0 : Added the pad_counts parameter.
  • 3.0.0 : Added the taxonomy parameter.
  • 3.4.0 : Removed show_last_update parameter.

Source File

wp_list_categories() is located in wp-includes/category-template.php.

Related

, get_categories

List & Dropdown Functions

See also index of Function Reference and index of Template Tags.