wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_category_checklist › WordPress Function

Since2.5.1
Deprecatedn/a
› wp_category_checklist ( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true )
Parameters: (6)
  • (int) $post_id Optional. Post to generate a categories checklist for. Default 0. $selected_cats must not be an array. Default 0.
    Required: No
    Default: —
  • (int) $descendants_and_self Optional. ID of the category to output along with its descendants. Default 0.
    Required: No
    Default: —
  • (int[]|false) $selected_cats Optional. Array of category IDs to mark as checked. Default false.
    Required: No
    Default: false
  • (int[]|false) $popular_cats Optional. Array of category IDs to receive the "popular-category" class. Default false.
    Required: No
    Default: false
  • (Walker) $walker Optional. Walker object to use to build the output. Default is a Walker_Category_Checklist instance.
    Required: No
    Default: null
  • (bool) $checked_ontop Optional. Whether to move checked items out of the hierarchy and to the top of the list. Default true.
    Required: No
    Default: true
See:
Defined at:
Codex:

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



Related Functions: wp_link_category_checklist, wp_terms_checklist, category_exists, wp_popular_terms_checklist, update_category_cache

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