Walker_CategoryDropdown::start_el() WordPress Method
The Walker_CategoryDropdown::start_el() method is used to display a category in a dropdown list. The method takes two arguments: the category name and the category ID. The method also has a number of options that can be set, such as the 'selected' option, which will make the category appear as selected in the dropdown list.
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
- $output
(string)(Required)Used to append additional content (passed by reference).
- $data_object
(WP_Term)(Required)Category data object.
- $depth
(int)(Required)Depth of category. Used for padding.
- $args
(array)(Optional)Uses 'selected', 'show_count', and 'value_field' keys, if they exist. See wp_dropdown_categories().
Default value: array()
- $current_object_id
(int)(Optional) ID of the current category. Default 0.
Source
File: wp-includes/class-walker-category-dropdown.php
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";
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.9.0 | Renamed $category to $data_object and $id to $current_object_id to match parent class for PHP 8 named parameter support. |
| 2.1.0 | Introduced. |