mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-28 16:49:40 +02:00
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
155 lines
5.6 KiB
PHP
155 lines
5.6 KiB
PHP
<?php
|
|
/**
|
|
* Custom page walker for this theme.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Twenty_Twenty
|
|
* @since Twenty Twenty 1.0
|
|
*/
|
|
|
|
if ( ! class_exists( 'TwentyTwenty_Walker_Page' ) ) {
|
|
/**
|
|
* CUSTOM PAGE WALKER
|
|
* A custom walker for pages.
|
|
*
|
|
* @since Twenty Twenty 1.0
|
|
*/
|
|
class TwentyTwenty_Walker_Page extends Walker_Page {
|
|
|
|
/**
|
|
* Outputs the beginning of the current element in the tree.
|
|
*
|
|
* @since Twenty Twenty 1.0
|
|
* @since Twenty Twenty 1.9 Renamed `$page` to `$data_object` and `$current_page` to `$current_object_id`
|
|
* to match parent class for PHP 8 named parameter support.
|
|
*
|
|
* @see Walker::start_el()
|
|
*
|
|
* @param string $output Used to append additional content. Passed by reference.
|
|
* @param WP_Post $data_object Page data object.
|
|
* @param int $depth Optional. Depth of page. Used for padding. Default 0.
|
|
* @param array $args Optional. Array of arguments. Default empty array.
|
|
* @param int $current_object_id Optional. ID of the current page. Default 0.
|
|
*/
|
|
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.
|
|
$page = $data_object;
|
|
$current_page_id = $current_object_id;
|
|
|
|
if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
|
|
$t = "\t";
|
|
$n = "\n";
|
|
} else {
|
|
$t = '';
|
|
$n = '';
|
|
}
|
|
if ( $depth ) {
|
|
$indent = str_repeat( $t, $depth );
|
|
} else {
|
|
$indent = '';
|
|
}
|
|
|
|
$css_class = array( 'page_item', 'page-item-' . $page->ID );
|
|
|
|
if ( isset( $args['pages_with_children'][ $page->ID ] ) ) {
|
|
$css_class[] = 'page_item_has_children';
|
|
}
|
|
|
|
if ( ! empty( $current_page_id ) ) {
|
|
$_current_page = get_post( $current_page_id );
|
|
if ( $_current_page && in_array( $page->ID, $_current_page->ancestors, true ) ) {
|
|
$css_class[] = 'current_page_ancestor';
|
|
}
|
|
if ( $page->ID === $current_page_id ) {
|
|
$css_class[] = 'current_page_item';
|
|
} elseif ( $_current_page && $page->ID === $_current_page->post_parent ) {
|
|
$css_class[] = 'current_page_parent';
|
|
}
|
|
} elseif ( get_option( 'page_for_posts' ) === $page->ID ) {
|
|
$css_class[] = 'current_page_parent';
|
|
}
|
|
|
|
/** This filter is documented in wp-includes/class-walker-page.php */
|
|
$css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page_id ) );
|
|
$css_classes = $css_classes ? ' class="' . esc_attr( $css_classes ) . '"' : '';
|
|
|
|
if ( '' === $page->post_title ) {
|
|
/* translators: %d: ID of a post. */
|
|
$page->post_title = sprintf( __( '#%d (no title)', 'twentytwenty' ), $page->ID );
|
|
}
|
|
|
|
$args['link_before'] = empty( $args['link_before'] ) ? '' : $args['link_before'];
|
|
$args['link_after'] = empty( $args['link_after'] ) ? '' : $args['link_after'];
|
|
|
|
$atts = array();
|
|
$atts['href'] = get_permalink( $page->ID );
|
|
$atts['aria-current'] = ( $page->ID === $current_page_id ) ? 'page' : '';
|
|
|
|
/** This filter is documented in wp-includes/class-walker-page.php */
|
|
$atts = apply_filters( 'page_menu_link_attributes', $atts, $page, $depth, $args, $current_page_id );
|
|
|
|
$attributes = '';
|
|
foreach ( $atts as $attr => $value ) {
|
|
if ( ! empty( $value ) ) {
|
|
$value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
|
|
$attributes .= ' ' . $attr . '="' . $value . '"';
|
|
}
|
|
}
|
|
|
|
$args['list_item_before'] = '';
|
|
$args['list_item_after'] = '';
|
|
|
|
// Wrap the link in a div and append a sub menu toggle.
|
|
if ( isset( $args['show_toggles'] ) && true === $args['show_toggles'] ) {
|
|
// Wrap the menu item link contents in a div, used for positioning.
|
|
$args['list_item_before'] = '<div class="ancestor-wrapper">';
|
|
$args['list_item_after'] = '';
|
|
|
|
// Add a toggle to items with children.
|
|
if ( isset( $args['pages_with_children'][ $page->ID ] ) ) {
|
|
|
|
$toggle_target_string = '.menu-modal .page-item-' . $page->ID . ' > ul';
|
|
$toggle_duration = twentytwenty_toggle_duration();
|
|
|
|
// Add the sub menu toggle.
|
|
$args['list_item_after'] .= '<button class="toggle sub-menu-toggle fill-children-current-color" data-toggle-target="' . $toggle_target_string . '" data-toggle-type="slidetoggle" data-toggle-duration="' . absint( $toggle_duration ) . '" aria-expanded="false"><span class="screen-reader-text">' . __( 'Show sub menu', 'twentytwenty' ) . '</span>' . twentytwenty_get_theme_svg( 'chevron-down' ) . '</button>';
|
|
|
|
}
|
|
|
|
// Close the wrapper.
|
|
$args['list_item_after'] .= '</div><!-- .ancestor-wrapper -->';
|
|
}
|
|
|
|
// Add icons to menu items with children.
|
|
if ( isset( $args['show_sub_menu_icons'] ) && true === $args['show_sub_menu_icons'] ) {
|
|
if ( isset( $args['pages_with_children'][ $page->ID ] ) ) {
|
|
$args['list_item_after'] = '<span class="icon"></span>';
|
|
}
|
|
}
|
|
|
|
$output .= $indent . sprintf(
|
|
'<li%s>%s<a%s>%s%s%s</a>%s',
|
|
$css_classes,
|
|
$args['list_item_before'],
|
|
$attributes,
|
|
$args['link_before'],
|
|
/** This filter is documented in wp-includes/post-template.php */
|
|
apply_filters( 'the_title', $page->post_title, $page->ID ),
|
|
$args['link_after'],
|
|
$args['list_item_after']
|
|
);
|
|
|
|
if ( ! empty( $args['show_date'] ) ) {
|
|
if ( 'modified' === $args['show_date'] ) {
|
|
$time = $page->post_modified;
|
|
} else {
|
|
$time = $page->post_date;
|
|
}
|
|
|
|
$date_format = empty( $args['date_format'] ) ? '' : $args['date_format'];
|
|
$output .= ' ' . mysql2date( $date_format, $time );
|
|
}
|
|
}
|
|
}
|
|
}
|