wp_category_checklist() – Function | Developer.WordPress.org

Outputs an unordered list of checkbox input elements labeled with category names.

Description

Parameters

$post_idintoptional: Post to generate a categories checklist for. Default 0.
$selected_cats must not be an array. Default 0.
$descendants_and_selfintoptional: ID of the category to output along with its descendants.
Default 0.
$selected_catsint[]|falseoptional: Array of category IDs to mark as checked.
Default:false
$popular_catsint[]|falseoptional: Array of category IDs to receive the "popular-category" class.

Default:false
$walkerWalkeroptional: Walker object to use to build the output.
Default is a Walker_Category_Checklist instance.
Default:null
$checked_ontopbooloptional: Whether to move checked items out of the hierarchy and to the top of the list.
Default:true

Source

function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) {
	wp_terms_checklist(
		$post_id,
		array(
			'taxonomy'             => 'category',
			'descendants_and_self' => $descendants_and_self,
			'selected_cats'        => $selected_cats,
			'popular_cats'         => $popular_cats,
			'walker'               => $walker,
			'checked_ontop'        => $checked_ontop,
		)
	);
}

View all references View on Trac View on GitHub

Changelog

Version	Description
2.5.1	Introduced.

User Contributed Notes

Skip to note 8 content

Codex 9 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
Basic Example

Outputs a list of all categories:
```
wp_category_checklist();
```
Log in to add feedback
Skip to note 9 content

Codex 9 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
Output a the list of a certain category and its descendants
```
wp_category_checklist( 0, $category_id = 22 );
```
Log in to add feedback
Skip to note 10 content

Codex 9 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
Mark all categories for a particular post as checked
```
wp_category_checklist( $post_id = 45 );
```
Log in to add feedback
Skip to note 11 content

Codex 9 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
Specify an array of categories to preselect instead
```
$selected_cats = array( 45, 33, 118 );

wp_category_checklist( 0, 0, $selected_cats );
```
Log in to add feedback
Skip to note 12 content

Codex 9 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
To override which categories will be marked as popular
```
$popular = array( 45, 33, 118 );

wp_category_checklist( 0, 0, false, $popular );
```
Log in to add feedback
Skip to note 13 content

Codex 9 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
Specify a walker object to use
```
$walker = new My_Walker_Category_Checklist();

wp_category_checklist( 0, 0, false, false, $walker );
```
Log in to add feedback
Skip to note 14 content

Codex 9 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
List the checked categories before the rest
```
$selected_cats = array( 45, 33, 118 );
$checked_ontop = true;

wp_category_checklist( 0, 0, $selected_cats, false, null, $checked_ontop );
```
You may also use any of the parameters in combination, except for $post_id and $selected_cats, which should not be used together.
Log in to add feedback

wp_category_checklist( int $post_id, int $descendants_and_self, int[]|false $selected_cats = false, int[]|false $popular_cats = false, Walker $walker = null, bool $checked_ontop = true )

In this article

Description

See also

Parameters

Source

Changelog

User Contributed Notes