2015-09-13 22:59:24 -04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Post API: Walker_Page class
|
|
|
|
*
|
|
|
|
* @package WordPress
|
2015-09-22 11:09:24 -04:00
|
|
|
* @subpackage Template
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 4.4.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2015-09-22 11:09:24 -04:00
|
|
|
* Core walker class used to create an HTML list of pages.
|
2015-09-13 22:59:24 -04:00
|
|
|
*
|
|
|
|
* @since 2.1.0
|
2015-09-22 09:54:24 -04:00
|
|
|
*
|
|
|
|
* @see Walker
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
class Walker_Page extends Walker {
|
2016-03-22 14:04:26 -04:00
|
|
|
|
2015-09-13 22:59:24 -04:00
|
|
|
/**
|
2016-03-22 14:04:26 -04:00
|
|
|
* What the class handles.
|
2015-12-14 13:06:31 -05:00
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 2.1.0
|
|
|
|
* @var string
|
2016-03-22 14:04:26 -04:00
|
|
|
*
|
|
|
|
* @see Walker::$tree_type
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
public $tree_type = 'page';
|
|
|
|
|
|
|
|
/**
|
2016-03-22 14:04:26 -04:00
|
|
|
* Database fields to use.
|
2015-12-14 13:06:31 -05:00
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 2.1.0
|
2016-03-22 14:04:26 -04:00
|
|
|
* @var array
|
|
|
|
*
|
2015-12-14 13:06:31 -05:00
|
|
|
* @see Walker::$db_fields
|
2015-09-13 22:59:24 -04:00
|
|
|
* @todo Decouple this.
|
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
public $db_fields = array(
|
|
|
|
'parent' => 'post_parent',
|
|
|
|
'id' => 'ID',
|
|
|
|
);
|
2015-09-13 22:59:24 -04:00
|
|
|
|
|
|
|
/**
|
2015-12-14 13:06:31 -05:00
|
|
|
* Outputs the beginning of the current level in the tree before elements are output.
|
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 2.1.0
|
|
|
|
*
|
2015-12-14 13:06:31 -05:00
|
|
|
* @see Walker::start_lvl()
|
|
|
|
*
|
2017-10-02 18:14:46 -04:00
|
|
|
* @param string $output Used to append additional content (passed by reference).
|
2015-12-14 13:06:31 -05:00
|
|
|
* @param int $depth Optional. Depth of page. Used for padding. Default 0.
|
2016-10-31 02:28:32 -04:00
|
|
|
* @param array $args Optional. Arguments for outputting the next level.
|
2015-12-14 13:06:31 -05:00
|
|
|
* Default empty array.
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
public function start_lvl( &$output, $depth = 0, $args = array() ) {
|
2017-01-24 18:29:42 -05:00
|
|
|
if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
|
2016-09-06 05:06:31 -04:00
|
|
|
$t = "\t";
|
|
|
|
$n = "\n";
|
|
|
|
} else {
|
|
|
|
$t = '';
|
|
|
|
$n = '';
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
$indent = str_repeat( $t, $depth );
|
2016-09-06 05:06:31 -04:00
|
|
|
$output .= "{$n}{$indent}<ul class='children'>{$n}";
|
2015-09-13 22:59:24 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-12-14 13:06:31 -05:00
|
|
|
* Outputs the end of the current level in the tree after elements are output.
|
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 2.1.0
|
|
|
|
*
|
2015-12-14 13:06:31 -05:00
|
|
|
* @see Walker::end_lvl()
|
|
|
|
*
|
2017-10-02 18:14:46 -04:00
|
|
|
* @param string $output Used to append additional content (passed by reference).
|
2015-12-14 13:06:31 -05:00
|
|
|
* @param int $depth Optional. Depth of page. Used for padding. Default 0.
|
|
|
|
* @param array $args Optional. Arguments for outputting the end of the current level.
|
|
|
|
* Default empty array.
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
public function end_lvl( &$output, $depth = 0, $args = array() ) {
|
2017-01-24 18:29:42 -05:00
|
|
|
if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
|
2016-09-06 05:06:31 -04:00
|
|
|
$t = "\t";
|
|
|
|
$n = "\n";
|
|
|
|
} else {
|
|
|
|
$t = '';
|
|
|
|
$n = '';
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
$indent = str_repeat( $t, $depth );
|
2016-09-06 05:06:31 -04:00
|
|
|
$output .= "{$indent}</ul>{$n}";
|
2015-09-13 22:59:24 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-12-14 13:06:31 -05:00
|
|
|
* Outputs the beginning of the current element in the tree.
|
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @see Walker::start_el()
|
|
|
|
* @since 2.1.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
|
|
|
* @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
|
2015-09-13 22:59:24 -04:00
|
|
|
*
|
2016-03-22 14:07:27 -04:00
|
|
|
* @param string $output Used to append additional content. Passed by reference.
|
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
|
|
|
* @param WP_Post $data_object Page data object.
|
2016-03-22 14:07:27 -04:00
|
|
|
* @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_page Optional. Page ID. Default 0.
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
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
|
|
|
public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_page = 0 ) {
|
|
|
|
// Restores the more descriptive, specific name for use within this method.
|
|
|
|
$page = $data_object;
|
|
|
|
|
2017-01-24 18:29:42 -05:00
|
|
|
if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
|
2016-09-06 05:06:31 -04:00
|
|
|
$t = "\t";
|
|
|
|
$n = "\n";
|
|
|
|
} else {
|
|
|
|
$t = '';
|
|
|
|
$n = '';
|
|
|
|
}
|
2015-09-13 22:59:24 -04:00
|
|
|
if ( $depth ) {
|
2016-09-06 05:06:31 -04:00
|
|
|
$indent = str_repeat( $t, $depth );
|
2015-09-13 22:59:24 -04:00
|
|
|
} 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 ) ) {
|
|
|
|
$_current_page = get_post( $current_page );
|
2020-04-09 11:43:10 -04:00
|
|
|
|
|
|
|
if ( $_current_page && in_array( $page->ID, $_current_page->ancestors, true ) ) {
|
2015-09-13 22:59:24 -04:00
|
|
|
$css_class[] = 'current_page_ancestor';
|
|
|
|
}
|
2020-04-09 11:43:10 -04:00
|
|
|
|
2015-09-13 22:59:24 -04:00
|
|
|
if ( $page->ID == $current_page ) {
|
|
|
|
$css_class[] = 'current_page_item';
|
2020-04-09 11:43:10 -04:00
|
|
|
} elseif ( $_current_page && $page->ID === $_current_page->post_parent ) {
|
2015-09-13 22:59:24 -04:00
|
|
|
$css_class[] = 'current_page_parent';
|
|
|
|
}
|
2020-02-09 11:55:09 -05:00
|
|
|
} elseif ( get_option( 'page_for_posts' ) == $page->ID ) {
|
2015-09-13 22:59:24 -04:00
|
|
|
$css_class[] = 'current_page_parent';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-05-22 14:50:28 -04:00
|
|
|
* Filters the list of CSS classes to include with each page item in the list.
|
2015-09-13 22:59:24 -04:00
|
|
|
*
|
|
|
|
* @since 2.8.0
|
|
|
|
*
|
|
|
|
* @see wp_list_pages()
|
|
|
|
*
|
2018-03-25 14:10:32 -04:00
|
|
|
* @param string[] $css_class An array of CSS classes to be applied to each list item.
|
|
|
|
* @param WP_Post $page Page data object.
|
|
|
|
* @param int $depth Depth of page, used for padding.
|
|
|
|
* @param array $args An array of arguments.
|
|
|
|
* @param int $current_page ID of the current page.
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
$css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page ) );
|
2019-01-07 07:55:38 -05:00
|
|
|
$css_classes = $css_classes ? ' class="' . esc_attr( $css_classes ) . '"' : '';
|
2015-09-13 22:59:24 -04:00
|
|
|
|
|
|
|
if ( '' === $page->post_title ) {
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %d: ID of a post. */
|
2015-09-13 22:59:24 -04:00
|
|
|
$page->post_title = sprintf( __( '#%d (no title)' ), $page->ID );
|
|
|
|
}
|
|
|
|
|
|
|
|
$args['link_before'] = empty( $args['link_before'] ) ? '' : $args['link_before'];
|
2017-11-30 18:11:00 -05:00
|
|
|
$args['link_after'] = empty( $args['link_after'] ) ? '' : $args['link_after'];
|
2015-09-13 22:59:24 -04:00
|
|
|
|
2019-01-07 08:36:50 -05:00
|
|
|
$atts = array();
|
|
|
|
$atts['href'] = get_permalink( $page->ID );
|
|
|
|
$atts['aria-current'] = ( $page->ID == $current_page ) ? 'page' : '';
|
2017-05-01 19:32:42 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Filters the HTML attributes applied to a page menu item's anchor element.
|
|
|
|
*
|
|
|
|
* @since 4.8.0
|
|
|
|
*
|
|
|
|
* @param array $atts {
|
|
|
|
* The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
|
|
|
|
*
|
2019-01-07 08:36:50 -05:00
|
|
|
* @type string $href The href attribute.
|
2021-05-07 05:46:58 -04:00
|
|
|
* @type string $aria-current The aria-current attribute.
|
2017-05-01 19:32:42 -04:00
|
|
|
* }
|
|
|
|
* @param WP_Post $page Page data object.
|
|
|
|
* @param int $depth Depth of page, used for padding.
|
|
|
|
* @param array $args An array of arguments.
|
|
|
|
* @param int $current_page ID of the current page.
|
|
|
|
*/
|
|
|
|
$atts = apply_filters( 'page_menu_link_attributes', $atts, $page, $depth, $args, $current_page );
|
|
|
|
|
|
|
|
$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:45:51 -04:00
|
|
|
$value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
|
2017-05-01 19:32:42 -04:00
|
|
|
$attributes .= ' ' . $attr . '="' . $value . '"';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-09-13 22:59:24 -04:00
|
|
|
$output .= $indent . sprintf(
|
2019-01-07 07:55:38 -05:00
|
|
|
'<li%s><a%s>%s%s%s</a>',
|
2015-09-13 22:59:24 -04:00
|
|
|
$css_classes,
|
2017-05-01 19:32:42 -04:00
|
|
|
$attributes,
|
2015-09-13 22:59:24 -04:00
|
|
|
$args['link_before'],
|
2016-01-05 11:35:26 -05:00
|
|
|
/** This filter is documented in wp-includes/post-template.php */
|
2015-09-13 22:59:24 -04:00
|
|
|
apply_filters( 'the_title', $page->post_title, $page->ID ),
|
|
|
|
$args['link_after']
|
|
|
|
);
|
|
|
|
|
|
|
|
if ( ! empty( $args['show_date'] ) ) {
|
2020-05-16 14:42:12 -04:00
|
|
|
if ( 'modified' === $args['show_date'] ) {
|
2015-09-13 22:59:24 -04:00
|
|
|
$time = $page->post_modified;
|
|
|
|
} else {
|
|
|
|
$time = $page->post_date;
|
|
|
|
}
|
|
|
|
|
|
|
|
$date_format = empty( $args['date_format'] ) ? '' : $args['date_format'];
|
2017-11-30 18:11:00 -05:00
|
|
|
$output .= ' ' . mysql2date( $date_format, $time );
|
2015-09-13 22:59:24 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-12-14 13:06:31 -05:00
|
|
|
* Outputs the end of the current element in the tree.
|
|
|
|
*
|
2015-09-13 22:59:24 -04:00
|
|
|
* @since 2.1.0
|
|
|
|
*
|
2015-12-14 13:06:31 -05:00
|
|
|
* @see Walker::end_el()
|
|
|
|
*
|
2016-03-22 14:07:27 -04:00
|
|
|
* @param string $output Used to append additional content. Passed by reference.
|
|
|
|
* @param WP_Post $page Page data object. Not used.
|
|
|
|
* @param int $depth Optional. Depth of page. Default 0 (unused).
|
|
|
|
* @param array $args Optional. Array of arguments. Default empty array.
|
2015-09-13 22:59:24 -04:00
|
|
|
*/
|
|
|
|
public function end_el( &$output, $page, $depth = 0, $args = array() ) {
|
2017-01-24 18:29:42 -05:00
|
|
|
if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
|
2016-09-06 05:06:31 -04:00
|
|
|
$t = "\t";
|
|
|
|
$n = "\n";
|
|
|
|
} else {
|
|
|
|
$t = '';
|
|
|
|
$n = '';
|
|
|
|
}
|
|
|
|
$output .= "</li>{$n}";
|
2015-09-13 22:59:24 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|