On this page
Walker_CategoryDropdown::start_el( string $output, WP_Term $data_object, int $depth, array $args = array(), int $current_object_id )
Starts the element output.
Description
See also
Parameters
$outputstring Required-
Used to append additional content (passed by reference).
$data_objectWP_Term Required-
Category data object.
$depthint Required-
Depth of category. Used for padding.
$argsarray Optional-
Uses
'selected','show_count', and'value_field'keys, if they exist.
See wp_dropdown_categories() .More Arguments from wp_dropdown_categories( ... $args )
Array or query string of term query parameters.
taxonomystring|string[]Taxonomy name, or array of taxonomy names, to which results should be limited.object_idsint|int[]Object ID, or array of object IDs. Results will be limited to terms associated with these objects.orderbystringField(s) to order terms by. Accepts:
- Term fields (
'name','slug','term_group','term_id','id','description','parent','term_order'). Unless$object_idsis not empty,'term_order'is treated the same as'term_id'. 'count'to use the number of objects associated with the term.'include'to match the'order'of the$includeparam.'slug__in'to match the'order'of the$slugparam.'meta_value''meta_value_num'.- The value of
$meta_key. - The array keys of
$meta_query. 'none'to omit the ORDER BY clause.
'name'.- Term fields (
orderstringWhether to order terms in ascending or descending order.
Accepts'ASC'(ascending) or'DESC'(descending).
Default'ASC'.hide_emptybool|intWhether to hide terms not assigned to any posts. Accepts1|trueor0|false. Default1|true.includeint[]|stringArray or comma/space-separated string of term IDs to include.
Default empty array.excludeint[]|stringArray or comma/space-separated string of term IDs to exclude.
If$includeis non-empty,$excludeis ignored.
Default empty array.exclude_treeint[]|stringArray or comma/space-separated string of term IDs to exclude along with all of their descendant terms. If$includeis non-empty,$exclude_treeis ignored. Default empty array.numberint|stringMaximum number of terms to return. Accepts(all) or any positive number. Default''|0(all). Note that''|0$numbermay not return accurate results when coupled with$object_ids.
See #41796 for details.offsetintThe number by which to offset the terms query.fieldsstringTerm fields to query for. Accepts:
'all'Returns an array of complete term objects (WP_Term[]).'all_with_object_id'Returns an array of term objects with the'object_id'param (WP_Term[]). Works only when the$object_idsparameter is populated.'ids'Returns an array of term IDs (int[]).'tt_ids'Returns an array of term taxonomy IDs (int[]).'names'Returns an array of term names (string[]).'slugs'Returns an array of term slugs (string[]).'count'Returns the number of matching terms (int).'id=>parent'Returns an associative array of parent term IDs, keyed by term ID (int[]).'id=>name'Returns an associative array of term names, keyed by term ID (string[]).'id=>slug'Returns an associative array of term slugs, keyed by term ID (string[]).
'all'.countboolWhether to return a term count. If true, will take precedence over$fields. Default false.namestring|string[]Name or array of names to return term(s) for.
slugstring|string[]Slug or array of slugs to return term(s) for.
term_taxonomy_idint|int[]Term taxonomy ID, or array of term taxonomy IDs, to match when querying terms.hierarchicalboolWhether to include terms that have non-empty descendants (even if$hide_emptyis set to true). Default true.searchstringSearch criteria to match terms. Will be SQL-formatted with wildcards before and after.name__likestringRetrieve terms with criteria by which a term is LIKE$name__like.description__likestringRetrieve terms where the description is LIKE$description__like.pad_countsboolWhether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false.getstringWhether to return terms regardless of ancestry or whether the terms are empty. Accepts'all'or''(disabled). Default''.child_ofintTerm ID to retrieve child terms of. If multiple taxonomies are passed,$child_ofis ignored. Default 0.parentintParent term ID to retrieve direct-child terms of.
childlessboolTrue to limit results to terms that have no children.
This parameter has no effect on non-hierarchical taxonomies.
Default false.cache_domainstringUnique cache key to be produced when this query is stored in an object cache. Default'core'.update_term_meta_cacheboolWhether to prime meta caches for matched terms. Default true.meta_keystring|string[]Meta key or keys to filter by.meta_valuestring|string[]Meta value or values to filter by.meta_comparestringMySQL operator used for comparing the meta value.
See WP_Meta_Query::__construct() for accepted values and default value.meta_compare_keystringMySQL operator used for comparing the meta key.
See WP_Meta_Query::__construct() for accepted values and default value.meta_typestringMySQL data type that the meta_value column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_type_keystringMySQL data type that the meta_key column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_queryarrayAn associative array of WP_Meta_Query arguments.
See WP_Meta_Query::__construct() for accepted values.
Default:
array() $current_object_idint Optional-
ID of the current category. Default 0.
Source
File: wp-includes/class-walker-category-dropdown.php. View all references
public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
// Restores the more descriptive, specific name for use within this method.
$category = $data_object;
$pad = str_repeat( ' ', $depth * 3 );
/** This filter is documented in wp-includes/category-template.php */
$cat_name = apply_filters( 'list_cats', $category->name, $category );
if ( isset( $args['value_field'] ) && isset( $category->{$args['value_field']} ) ) {
$value_field = $args['value_field'];
} else {
$value_field = 'term_id';
}
$output .= "\t<option class=\"level-$depth\" value=\"" . esc_attr( $category->{$value_field} ) . '"';
// Type-juggling causes false matches, so we force everything to a string.
if ( (string) $category->{$value_field} === (string) $args['selected'] ) {
$output .= ' selected="selected"';
}
$output .= '>';
$output .= $pad . $cat_name;
if ( $args['show_count'] ) {
$output .= ' (' . number_format_i18n( $category->count ) . ')';
}
$output .= "</option>\n";
}
Hooks
- apply_filters( 'list_cats',
string $element ,WP_Term|null $category ) -
Filters a taxonomy drop-down display element.
Related
Uses
| Uses | Description |
|---|---|
| esc_attr() wp-includes/formatting.php | Escaping for HTML attributes. |
| number_format_i18n() wp-includes/functions.php | Converts float number to format based on the locale. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/walker_categorydropdown/start_el