2015-09-13 23:10:24 -04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-09-22 10:01:25 -04:00
|
|
|
* Taxonomy API: Walker_Category class
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage Template
|
2015-09-22 10:01:25 -04:00
|
|
|
* @since 4.4.0
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2015-09-22 10:01:25 -04:00
|
|
|
* Core class used to create an HTML list of categories.
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
|
|
|
* @since 2.1.0
|
2015-09-22 10:01:25 -04:00
|
|
|
*
|
|
|
|
* @see Walker
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
class Walker_Category extends Walker {
|
2016-03-22 13:25:26 -04:00
|
|
|
|
2015-09-13 23:10:24 -04:00
|
|
|
/**
|
|
|
|
* What the class handles.
|
|
|
|
*
|
|
|
|
* @since 2.1.0
|
|
|
|
* @var string
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::$tree_type
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
public $tree_type = 'category';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Database fields to use.
|
|
|
|
*
|
|
|
|
* @since 2.1.0
|
|
|
|
* @var array
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::$db_fields
|
2016-03-22 13:30:26 -04:00
|
|
|
* @todo Decouple this
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
public $db_fields = array(
|
|
|
|
'parent' => 'parent',
|
|
|
|
'id' => 'term_id',
|
|
|
|
);
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Starts the list before the elements are added.
|
|
|
|
*
|
|
|
|
* @since 2.1.0
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::start_lvl()
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
2016-03-22 13:30:26 -04:00
|
|
|
* @param string $output Used to append additional content. Passed by reference.
|
|
|
|
* @param int $depth Optional. Depth of category. Used for tab indentation. Default 0.
|
|
|
|
* @param array $args Optional. An array of arguments. Will only append content if style argument
|
|
|
|
* value is 'list'. See wp_list_categories(). Default empty array.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
public function start_lvl( &$output, $depth = 0, $args = array() ) {
|
2020-05-16 14:42:12 -04:00
|
|
|
if ( 'list' !== $args['style'] ) {
|
2015-09-13 23:10:24 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2015-09-13 23:10:24 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$indent = str_repeat( "\t", $depth );
|
2015-09-13 23:10:24 -04:00
|
|
|
$output .= "$indent<ul class='children'>\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Ends the list of after the elements are added.
|
|
|
|
*
|
|
|
|
* @since 2.1.0
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::end_lvl()
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
2016-03-22 13:30:26 -04:00
|
|
|
* @param string $output Used to append additional content. Passed by reference.
|
|
|
|
* @param int $depth Optional. Depth of category. Used for tab indentation. Default 0.
|
|
|
|
* @param array $args Optional. An array of arguments. Will only append content if style argument
|
|
|
|
* value is 'list'. See wp_list_categories(). Default empty array.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
public function end_lvl( &$output, $depth = 0, $args = array() ) {
|
2020-05-16 14:42:12 -04:00
|
|
|
if ( 'list' !== $args['style'] ) {
|
2015-09-13 23:10:24 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2015-09-13 23:10:24 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$indent = str_repeat( "\t", $depth );
|
2015-09-13 23:10:24 -04:00
|
|
|
$output .= "$indent</ul>\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-03-22 13:25:26 -04:00
|
|
|
* Starts the element output.
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
|
|
|
* @since 2.1.0
|
Code Modernization: Fix last parameter name mismatches for parent/child classes in `Walker::start_el()`.
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51779
git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 08:39:59 -04:00
|
|
|
* @since 5.9.0 Renamed `$category` to `$data_object` and `$id` to `$current_object_id`
|
|
|
|
* to match parent class for PHP 8 named parameter support.
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::start_el()
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
Code Modernization: Fix last parameter name mismatches for parent/child classes in `Walker::start_el()`.
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51779
git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 08:39:59 -04:00
|
|
|
* @param string $output Used to append additional content (passed by reference).
|
|
|
|
* @param WP_Term $data_object Category data object.
|
|
|
|
* @param int $depth Optional. Depth of category in reference to parents. Default 0.
|
|
|
|
* @param array $args Optional. An array of arguments. See wp_list_categories().
|
|
|
|
* Default empty array.
|
|
|
|
* @param int $current_object_id Optional. ID of the current category. Default 0.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
Code Modernization: Fix last parameter name mismatches for parent/child classes in `Walker::start_el()`.
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51779
git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 08:39:59 -04:00
|
|
|
public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
|
Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `Walker::start_el()`.
In the parent class, renames the parameter `$object` to `$data_object`.
Why? `object` is a PHP reserved keyword.
In each child class: renames the corresponding parameter to match the parent's method signature.
Why?
PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- in methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- in cases where the original parameter name was too generic, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51739
git-svn-id: http://core.svn.wordpress.org/trunk@51347 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-08 11:36:59 -04:00
|
|
|
// Restores the more descriptive, specific name for use within this method.
|
|
|
|
$category = $data_object;
|
|
|
|
|
2015-09-13 23:10:24 -04:00
|
|
|
/** This filter is documented in wp-includes/category-template.php */
|
2019-09-10 15:23:55 -04:00
|
|
|
$cat_name = apply_filters( 'list_cats', esc_attr( $category->name ), $category );
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
// Don't generate an element if the category name is empty.
|
2018-09-02 18:09:24 -04:00
|
|
|
if ( '' === $cat_name ) {
|
2015-09-13 23:10:24 -04:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2019-03-21 06:37:57 -04:00
|
|
|
$atts = array();
|
|
|
|
$atts['href'] = get_term_link( $category );
|
|
|
|
|
2015-09-13 23:10:24 -04:00
|
|
|
if ( $args['use_desc_for_title'] && ! empty( $category->description ) ) {
|
|
|
|
/**
|
2016-05-22 14:50:28 -04:00
|
|
|
* Filters the category description for display.
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
|
|
|
* @since 1.2.0
|
|
|
|
*
|
2020-10-17 12:05:09 -04:00
|
|
|
* @param string $description Category description.
|
|
|
|
* @param WP_Term $category Category object.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
2019-03-21 06:37:57 -04:00
|
|
|
$atts['title'] = strip_tags( apply_filters( 'category_description', $category->description, $category ) );
|
2015-09-13 23:10:24 -04:00
|
|
|
}
|
|
|
|
|
2019-03-21 06:37:57 -04:00
|
|
|
/**
|
|
|
|
* Filters the HTML attributes applied to a category list item's anchor element.
|
|
|
|
*
|
|
|
|
* @since 5.2.0
|
|
|
|
*
|
|
|
|
* @param array $atts {
|
|
|
|
* The HTML attributes applied to the list item's `<a>` element, empty strings are ignored.
|
|
|
|
*
|
|
|
|
* @type string $href The href attribute.
|
|
|
|
* @type string $title The title attribute.
|
|
|
|
* }
|
Code Modernization: Fix last parameter name mismatches for parent/child classes in `Walker::start_el()`.
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51779
git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 08:39:59 -04:00
|
|
|
* @param WP_Term $category Term data object.
|
|
|
|
* @param int $depth Depth of category, used for padding.
|
|
|
|
* @param array $args An array of arguments.
|
|
|
|
* @param int $current_object_id ID of the current category.
|
2019-03-21 06:37:57 -04:00
|
|
|
*/
|
Code Modernization: Fix last parameter name mismatches for parent/child classes in `Walker::start_el()`.
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.
- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.
Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51779
git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 08:39:59 -04:00
|
|
|
$atts = apply_filters( 'category_list_link_attributes', $atts, $category, $depth, $args, $current_object_id );
|
2019-03-21 06:37:57 -04:00
|
|
|
|
|
|
|
$attributes = '';
|
|
|
|
foreach ( $atts as $attr => $value ) {
|
2019-10-06 11:06:03 -04:00
|
|
|
if ( is_scalar( $value ) && '' !== $value && false !== $value ) {
|
2019-03-21 06:37:57 -04:00
|
|
|
$value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
|
|
|
|
$attributes .= ' ' . $attr . '="' . $value . '"';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$link = sprintf(
|
|
|
|
'<a%s>%s</a>',
|
|
|
|
$attributes,
|
|
|
|
$cat_name
|
|
|
|
);
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
|
|
|
|
$link .= ' ';
|
|
|
|
|
|
|
|
if ( empty( $args['feed_image'] ) ) {
|
|
|
|
$link .= '(';
|
|
|
|
}
|
|
|
|
|
Taxonomy: Allow `get_*_*_link()` and `edit_term_link()` functions to accept a term ID, `WP_Term`, or term object.
`get_term()` accepts a term ID, instance of `WP_Term`, or an object (i.e. `stdClass` as a result of a db query). Functions that use `get_term()` also now allow for the same data types.
Why? For consistency, removing extra processing code in consuming functions, and performance.
Functions changed in this commit are:
* `get_category_feed_link()`
* `get_term_feed_link()`
* `get_tag_feed_link()`
* `get_edit_tag_link()`
* `get_edit_term_link()`
* `edit_term_link()`
For each of consumer of these functions, changes to pass the object instead of the term ID.
Includes unit/integration tests for test coverage of these changes.
Follow-up to [6365], [9136], [9340], [14711], [15792], [15800], [18827], [32606], [36646], [37252].
Props davidbinda, johnbillion, peterwilsoncc, hellofromTonya, sergeybiryukov, mista-flo, hareesh-pillai, audrasjb, jeffpaul, chaion07.
Fixes #50225.
Built from https://develop.svn.wordpress.org/trunk@52180
git-svn-id: http://core.svn.wordpress.org/trunk@51772 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-11-16 09:57:02 -05:00
|
|
|
$link .= '<a href="' . esc_url( get_term_feed_link( $category, $category->taxonomy, $args['feed_type'] ) ) . '"';
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
if ( empty( $args['feed'] ) ) {
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %s: Category name. */
|
2017-11-30 18:11:00 -05:00
|
|
|
$alt = ' alt="' . sprintf( __( 'Feed for all posts filed under %s' ), $cat_name ) . '"';
|
2015-09-13 23:10:24 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$alt = ' alt="' . $args['feed'] . '"';
|
|
|
|
$name = $args['feed'];
|
2015-09-13 23:10:24 -04:00
|
|
|
$link .= empty( $args['title'] ) ? '' : $args['title'];
|
|
|
|
}
|
|
|
|
|
|
|
|
$link .= '>';
|
|
|
|
|
|
|
|
if ( empty( $args['feed_image'] ) ) {
|
|
|
|
$link .= $name;
|
|
|
|
} else {
|
2019-01-07 07:48:51 -05:00
|
|
|
$link .= "<img src='" . esc_url( $args['feed_image'] ) . "'$alt" . ' />';
|
2015-09-13 23:10:24 -04:00
|
|
|
}
|
|
|
|
$link .= '</a>';
|
|
|
|
|
|
|
|
if ( empty( $args['feed_image'] ) ) {
|
|
|
|
$link .= ')';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( ! empty( $args['show_count'] ) ) {
|
|
|
|
$link .= ' (' . number_format_i18n( $category->count ) . ')';
|
|
|
|
}
|
2020-05-16 14:42:12 -04:00
|
|
|
if ( 'list' === $args['style'] ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$output .= "\t<li";
|
2015-09-13 23:10:24 -04:00
|
|
|
$css_classes = array(
|
|
|
|
'cat-item',
|
|
|
|
'cat-item-' . $category->term_id,
|
|
|
|
);
|
|
|
|
|
|
|
|
if ( ! empty( $args['current_category'] ) ) {
|
|
|
|
// 'current_category' can be an array, so we use `get_terms()`.
|
2017-11-30 18:11:00 -05:00
|
|
|
$_current_terms = get_terms(
|
2018-08-16 21:51:36 -04:00
|
|
|
array(
|
2019-08-02 23:35:56 -04:00
|
|
|
'taxonomy' => $category->taxonomy,
|
2017-11-30 18:11:00 -05:00
|
|
|
'include' => $args['current_category'],
|
|
|
|
'hide_empty' => false,
|
|
|
|
)
|
|
|
|
);
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
foreach ( $_current_terms as $_current_term ) {
|
|
|
|
if ( $category->term_id == $_current_term->term_id ) {
|
|
|
|
$css_classes[] = 'current-cat';
|
2019-09-18 08:25:56 -04:00
|
|
|
$link = str_replace( '<a', '<a aria-current="page"', $link );
|
2015-09-13 23:10:24 -04:00
|
|
|
} elseif ( $category->term_id == $_current_term->parent ) {
|
|
|
|
$css_classes[] = 'current-cat-parent';
|
|
|
|
}
|
2015-12-18 13:38:25 -05:00
|
|
|
while ( $_current_term->parent ) {
|
|
|
|
if ( $category->term_id == $_current_term->parent ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$css_classes[] = 'current-cat-ancestor';
|
2015-12-18 13:38:25 -05:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
$_current_term = get_term( $_current_term->parent, $category->taxonomy );
|
|
|
|
}
|
2015-09-13 23:10:24 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-05-22 14:50:28 -04:00
|
|
|
* Filters the list of CSS classes to include with each category in the list.
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
|
|
|
* @since 4.2.0
|
|
|
|
*
|
|
|
|
* @see wp_list_categories()
|
|
|
|
*
|
2020-10-17 12:05:09 -04:00
|
|
|
* @param string[] $css_classes An array of CSS classes to be applied to each list item.
|
|
|
|
* @param WP_Term $category Category data object.
|
|
|
|
* @param int $depth Depth of page, used for padding.
|
|
|
|
* @param array $args An array of wp_list_categories() arguments.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
|
|
|
$css_classes = implode( ' ', apply_filters( 'category_css_class', $css_classes, $category, $depth, $args ) );
|
2019-01-07 07:54:48 -05:00
|
|
|
$css_classes = $css_classes ? ' class="' . esc_attr( $css_classes ) . '"' : '';
|
2015-09-13 23:10:24 -04:00
|
|
|
|
2019-01-07 07:54:48 -05:00
|
|
|
$output .= $css_classes;
|
2015-09-13 23:10:24 -04:00
|
|
|
$output .= ">$link\n";
|
2015-10-13 13:02:25 -04:00
|
|
|
} elseif ( isset( $args['separator'] ) ) {
|
|
|
|
$output .= "\t$link" . $args['separator'] . "\n";
|
2015-09-13 23:10:24 -04:00
|
|
|
} else {
|
|
|
|
$output .= "\t$link<br />\n";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Ends the element output, if needed.
|
|
|
|
*
|
|
|
|
* @since 2.1.0
|
Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `Walker::end_el()`.
In the parent class, renames the parameter `$object` to `$data_object`.
Why? `object` is a PHP reserved keyword. The parameter name is selected for consistency with `Walker::start_el()`.
In each child class: renames the parameter to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
Follow-up to [7737], [8900], [8970], [14248], [16100], [25642], [25644], [37051], [37056].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51780
git-svn-id: http://core.svn.wordpress.org/trunk@51387 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 09:03:55 -04:00
|
|
|
* @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
|
2016-03-22 13:25:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::end_el()
|
2015-09-13 23:10:24 -04:00
|
|
|
*
|
Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `Walker::end_el()`.
In the parent class, renames the parameter `$object` to `$data_object`.
Why? `object` is a PHP reserved keyword. The parameter name is selected for consistency with `Walker::start_el()`.
In each child class: renames the parameter to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
Follow-up to [7737], [8900], [8970], [14248], [16100], [25642], [25644], [37051], [37056].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51780
git-svn-id: http://core.svn.wordpress.org/trunk@51387 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 09:03:55 -04:00
|
|
|
* @param string $output Used to append additional content (passed by reference).
|
|
|
|
* @param object $data_object Category data object. Not used.
|
|
|
|
* @param int $depth Optional. Depth of category. Not used.
|
|
|
|
* @param array $args Optional. An array of arguments. Only uses 'list' for whether should
|
|
|
|
* append to output. See wp_list_categories(). Default empty array.
|
2015-09-13 23:10:24 -04:00
|
|
|
*/
|
Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `Walker::end_el()`.
In the parent class, renames the parameter `$object` to `$data_object`.
Why? `object` is a PHP reserved keyword. The parameter name is selected for consistency with `Walker::start_el()`.
In each child class: renames the parameter to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.
Changes for readability:
- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.
Follow-up to [7737], [8900], [8970], [14248], [16100], [25642], [25644], [37051], [37056].
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.
Built from https://develop.svn.wordpress.org/trunk@51780
git-svn-id: http://core.svn.wordpress.org/trunk@51387 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 09:03:55 -04:00
|
|
|
public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
|
2020-05-16 14:42:12 -04:00
|
|
|
if ( 'list' !== $args['style'] ) {
|
2015-09-13 23:10:24 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2015-09-13 23:10:24 -04:00
|
|
|
|
|
|
|
$output .= "</li>\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|