wp_terms_checklist( int $post_id = 0, array|string $args = array() ): string

Description

Parameters

$post_idintoptional

Post ID. Default 0.Default: 0

$argsarray|stringoptional

Array or string of arguments for generating a terms checklist. Default empty array.Default: array()

• $descendants_and_selfintdefault: 0

  ID of the category to output along with its descendants.

• $selected_catsint[]default: false

  Array of category IDs to mark as checked.

• $popular_catsint[]default: false

  Array of category IDs to receive the "popular-category" class.

• $walkerWalkerdefault: empty which results in a Walker_Category_Checklist instance being used

  Walker object to use to build the output.

• $taxonomystringdefault: 'category'

  Taxonomy to generate the checklist for.

• $checked_ontopbooldefault: true

  Whether to move checked items out of the hierarchy and to the top of the list.

• $echobooldefault: true

  Whether to echo the generated markup. False to return the markup instead of echoing it.

Return

string

HTML list of input elements.

Hooks fired · 1

One hook fires while wp_terms_checklist() runs, in this order:

1. 1
   apply_filters( wp_terms_checklist_args )filterline 102 (+21 into the body)

   Filters the taxonomy terms checklist arguments.

Uses · 8

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• current_user_can()Returns whether the current user has the specified capability.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.
• get_term()Gets all term data from database by term ID.
• Walker_Category_Checklist::__construct()

Used by · 4

• WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
• _wp_ajax_add_hierarchical_term()Handles adding a hierarchical term via AJAX.
• post_categories_meta_box()Displays post categories form fields.
• wp_category_checklist()Outputs an unordered list of checkbox input elements labeled with category names.

Source

View on Trac ↗View on GitHub ↗

81function wp_terms_checklist( $post_id = 0, $args = array() ) {82	$defaults = array(83		'descendants_and_self' => 0,84		'selected_cats'        => false,85		'popular_cats'         => false,86		'walker'               => null,87		'taxonomy'             => 'category',88		'checked_ontop'        => true,89		'echo'                 => true,90	);91 92	/**93	 * Filters the taxonomy terms checklist arguments.94	 *95	 * @since 3.4.096	 *97	 * @see wp_terms_checklist()98	 *99	 * @param array|string $args    An array or string of arguments.100	 * @param int          $post_id The post ID.101	 */102	$params = apply_filters( 'wp_terms_checklist_args', $args, $post_id );103 104	$parsed_args = wp_parse_args( $params, $defaults );105 106	if ( empty( $parsed_args['walker'] ) || ! ( $parsed_args['walker'] instanceof Walker ) ) {107		$walker = new Walker_Category_Checklist();108	} else {109		$walker = $parsed_args['walker'];110	}111 112	$taxonomy             = $parsed_args['taxonomy'];113	$descendants_and_self = (int) $parsed_args['descendants_and_self'];114 115	$args = array( 'taxonomy' => $taxonomy );116 117	$tax              = get_taxonomy( $taxonomy );118	$args['disabled'] = ! current_user_can( $tax->cap->assign_terms );119 120	$args['list_only'] = ! empty( $parsed_args['list_only'] );121 122	if ( is_array( $parsed_args['selected_cats'] ) ) {123		$args['selected_cats'] = array_map( 'intval', $parsed_args['selected_cats'] );124	} elseif ( $post_id ) {125		$args['selected_cats'] = wp_get_object_terms( $post_id, $taxonomy, array_merge( $args, array( 'fields' => 'ids' ) ) );126	} else {127		$args['selected_cats'] = array();128	}129 130	if ( is_array( $parsed_args['popular_cats'] ) ) {131		$args['popular_cats'] = array_map( 'intval', $parsed_args['popular_cats'] );132	} else {133		$args['popular_cats'] = get_terms(134			array(135				'taxonomy'     => $taxonomy,136				'fields'       => 'ids',137				'orderby'      => 'count',138				'order'        => 'DESC',139				'number'       => 10,140				'hierarchical' => false,141			)142		);143	}144 145	if ( $descendants_and_self ) {146		$categories = (array) get_terms(147			array(148				'taxonomy'     => $taxonomy,149				'child_of'     => $descendants_and_self,150				'hierarchical' => 0,151				'hide_empty'   => 0,152			)153		);154		$self       = get_term( $descendants_and_self, $taxonomy );155		array_unshift( $categories, $self );156	} else {157		$categories = (array) get_terms(158			array(159				'taxonomy' => $taxonomy,160				'get'      => 'all',

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.