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 )

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


Top ↑

See also

Top ↑


$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 int[]|false Optional
Array of category IDs to mark as checked.

Default: false

$popular_cats int[]|false Optional
Array of category IDs to receive the "popular-category" class.

Default: false

$walker Walker Optional
Walker object to use to build the output.
Default is a Walker_Category_Checklist instance.

Default: null

$checked_ontop bool Optional
Whether to move checked items out of the hierarchy and to the top of the list.

Default: true

Top ↑


File: wp-admin/includes/template.php. View all references

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

Top ↑


Version Description
2.5.1 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 7 content
    Contributed by Codex

    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.

You must log in before being able to contribute a note or feedback.