| @@ -6,10 +6,18 @@ | ||
| 6 | 6 | /** |
| 7 | 7 | * Displays a language list |
| 8 | 8 | * |
| 9 | 9 | * @since 1.2 |
| 10 | + * @since 3.4 Extends `PLL_Walker` now. | |
| 10 | 11 | */ |
| 11 | -class PLL_Walker_List extends Walker { | |
| 12 | +class PLL_Walker_List extends PLL_Walker { | |
| 13 | + /** | |
| 14 | + * Database fields to use. | |
| 15 | + * | |
| 16 | + * @see https://developer.wordpress.org/reference/classes/walker/#properties Walker::$db_fields. | |
| 17 | + * | |
| 18 | + * @var string[] | |
| 19 | + */ | |
| 12 | 20 | public $db_fields = array( 'parent' => 'parent', 'id' => 'id' ); |
| 13 | 21 | |
| 14 | 22 | /** |
| 15 | 23 | * Outputs one element |
| @@ -15,22 +23,50 @@ | ||
| 15 | 23 | * Outputs one element |
| 16 | 24 | * |
| 17 | 25 | * @since 1.2 |
| 18 | 26 | * |
| 19 | - * @param string $output Passed by reference. Used to append additional content. | |
| 20 | - * @param object $element The data object. | |
| 21 | - * @param int $depth Depth of the item. | |
| 22 | - * @param array $args An array of additional arguments. | |
| 23 | - * @param int $current_object_id ID of the current item. | |
| 27 | + * @param string $output Passed by reference. Used to append additional content. | |
| 28 | + * @param stdClass $element The data object. | |
| 29 | + * @param int $depth Depth of the item. | |
| 30 | + * @param array $args An array of additional arguments. | |
| 31 | + * @param int $current_object_id ID of the current item. | |
| 32 | + * @return void | |
| 24 | 33 | */ |
| 25 | 34 | public function start_el( &$output, $element, $depth = 0, $args = array(), $current_object_id = 0 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 35 | + // Link attributes. | |
| 36 | + $link_atts = sprintf( | |
| 37 | + 'lang="%1$s" hreflang="%1$s" href="%2$s"', | |
| 38 | + esc_attr( $element->locale ), | |
| 39 | + esc_url( $element->url ) | |
| 40 | + ); | |
| 41 | + | |
| 42 | + if ( ! empty( $element->link_classes ) ) { | |
| 43 | + $link_atts .= sprintf( | |
| 44 | + ' class="%s"', | |
| 45 | + esc_attr( implode( ' ', $element->link_classes ) ) | |
| 46 | + ); | |
| 47 | + } | |
| 48 | + if ( ! empty( $element->current_lang ) ) { | |
| 49 | + $link_atts .= ' aria-current="true"'; | |
| 50 | + } | |
| 51 | + | |
| 52 | + // Text label. | |
| 53 | + if ( $args['show_flags'] && $args['show_names'] ) { | |
| 54 | + $label = sprintf( | |
| 55 | + '<span style="margin-%1$s:0.3em;">%2$s</span>', | |
| 56 | + is_rtl() ? 'right' : 'left', | |
| 57 | + esc_html( $element->name ) | |
| 58 | + ); | |
| 59 | + } else { | |
| 60 | + $label = esc_html( $element->name ); | |
| 61 | + } | |
| 62 | + | |
| 26 | 63 | $output .= sprintf( |
| 27 | - '%6$s<li class="%1$s"><a lang="%2$s" hreflang="%2$s" href="%3$s">%4$s%5$s</a></li>%7$s', | |
| 64 | + '%5$s<li class="%1$s"><a %2$s>%3$s%4$s</a></li>%6$s', | |
| 28 | 65 | esc_attr( implode( ' ', $element->classes ) ), |
| 29 | - esc_attr( $element->locale ), | |
| 30 | - esc_url( $element->url ), | |
| 66 | + $link_atts, | |
| 31 | 67 | $element->flag, |
| 32 | - $args['show_flags'] && $args['show_names'] ? sprintf( '<span style="margin-%1$s:0.3em;">%2$s</span>', is_rtl() ? 'right' : 'left', esc_html( $element->name ) ) : esc_html( $element->name ), | |
| 68 | + $label, | |
| 33 | 69 | 'discard' === $args['item_spacing'] ? '' : "\t", |
| 34 | 70 | 'discard' === $args['item_spacing'] ? '' : "\n" |
| 35 | 71 | ); |
| 36 | 72 | } |
| @@ -35,26 +71,8 @@ | ||
| 35 | 71 | ); |
| 36 | 72 | } |
| 37 | 73 | |
| 38 | 74 | /** |
| 39 | - * Overrides Walker::display_element as it expects an object with a parent property | |
| 40 | - * | |
| 41 | - * @since 1.2 | |
| 42 | - * | |
| 43 | - * @param object $element Data object. | |
| 44 | - * @param array $children_elements List of elements to continue traversing. | |
| 45 | - * @param int $max_depth Max depth to traverse. | |
| 46 | - * @param int $depth Depth of current element. | |
| 47 | - * @param array $args An array of arguments. | |
| 48 | - * @param string $output Passed by reference. Used to append additional content. | |
| 49 | - */ | |
| 50 | - public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) { | |
| 51 | - $element = (object) $element; // Make sure we have an object | |
| 52 | - $element->parent = $element->id = 0; // Don't care about this | |
| 53 | - parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); | |
| 54 | - } | |
| 55 | - | |
| 56 | - /** | |
| 57 | 75 | * Overrides Walker:walk to set depth argument |
| 58 | 76 | * |
| 59 | 77 | * @since 1.2 |
| 60 | 78 | * @since 2.6.7 Use $max_depth and ...$args parameters to follow the move of WP 5.3 |
| @@ -64,23 +82,9 @@ | ||
| 64 | 82 | * @param mixed ...$args Additional arguments. |
| 65 | 83 | * @return string The hierarchical item output. |
| 66 | 84 | */ |
| 67 | 85 | public function walk( $elements, $max_depth, ...$args ) { // phpcs:ignore WordPressVIPMinimum.Classes.DeclarationCompatibility.DeclarationCompatibility |
| 68 | - if ( is_array( $max_depth ) ) { | |
| 69 | - // Backward compatibility with Polylang < 2.6.7 | |
| 70 | - if ( WP_DEBUG ) { | |
| 71 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 72 | - sprintf( | |
| 73 | - '%s was called incorrectly. The method expects an integer as second parameter since Polylang 2.6.7', | |
| 74 | - __METHOD__ | |
| 75 | - ) | |
| 76 | - ); | |
| 77 | - } | |
| 78 | - $args = $max_depth; | |
| 79 | - $max_depth = -1; | |
| 80 | - } else { | |
| 81 | - $args = isset( $args[0] ) ? $args[0] : array(); | |
| 82 | - } | |
| 86 | + $this->maybe_fix_walk_args( $max_depth, $args ); | |
| 83 | 87 | |
| 84 | 88 | return parent::walk( $elements, $max_depth, $args ); |
| 85 | 89 | } |
| 86 | 90 | } |