wp_category_checklist( int $post_id, int $descendants_and_self, array $selected_cats = false, array $popular_cats = false, object $walker = null, bool $checked_ontop = true )

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


Description

See also


Parameters

$post_id

(int) (Optional) Post to generate a categories checklist for. Default 0. $selected_cats must not be an array. Default 0.

$descendants_and_self

(int) (Optional) ID of the category to output along with its descendants. Default 0.

$selected_cats

(array) (Optional) List of categories to mark as checked.

Default value: false

$popular_cats

(array) (Optional) List of categories to receive the "popular-category" class.

Default value: false

$walker

(object) (Optional) Walker object to use to build the output. Default is a Walker_Category_Checklist instance.

Default value: null

$checked_ontop

(bool) (Optional) Whether to move checked items out of the hierarchy and to the top of the list.

Default value: true


Source

File: wp-admin/includes/template.php

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
	) );
}


Changelog

Changelog
Version Description
WP-2.5.1 Introduced.