PluginProbe
Polylang / 2.9
Polylang v2.9
3.8.9 3.8.8 3.8.7 3.8.6 3.8.5 3.8.4 3.8.3 2.7 2.7.0.1 2.7.1 2.7.2 2.7.3 2.7.4 2.8 2.8.1 2.8.2 2.8.3 2.8.4 2.9 2.9.1 2.9.2 3.0 3.0.1 3.0.2 3.0.3 All 233 releases
polylang / include / walker-dropdown.php

walker-dropdown.php in Polylang 2.9, at include/walker-dropdown.php

117 lines 4.3 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * @package Polylang
4 */
5
6 /**
7 * Displays languages in a dropdown list
8 *
9 * @since 1.2
10 */
11 class PLL_Walker_Dropdown extends Walker {
12 public $db_fields = array( 'parent' => 'parent', 'id' => 'id' );
13
14 /**
15 * Outputs one element
16 *
17 * @since 1.2
18 *
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.
24 */
25 public function start_el( &$output, $element, $depth = 0, $args = array(), $current_object_id = 0 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
26 $value = $args['value'];
27 $output .= sprintf(
28 "\t" . '<option value="%1$s"%2$s%3$s>%4$s</option>' . "\n",
29 esc_attr( $element->$value ),
30 method_exists( $element, 'get_locale' ) ? sprintf( ' lang="%s"', esc_attr( $element->get_locale( 'display' ) ) ) : '',
31 selected( isset( $args['selected'] ) && $args['selected'] === $element->$value, true, false ),
32 esc_html( $element->name )
33 );
34 }
35
36 /**
37 * Overrides Walker::display_element as expects an object with a parent property
38 *
39 * @since 1.2
40 *
41 * @param object $element Data object.
42 * @param array $children_elements List of elements to continue traversing.
43 * @param int $max_depth Max depth to traverse.
44 * @param int $depth Depth of current element.
45 * @param array $args An array of arguments.
46 * @param string $output Passed by reference. Used to append additional content.
47 */
48 public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
49 $element = (object) $element; // Make sure we have an object
50 $element->parent = $element->id = 0; // Don't care about this
51 parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
52 }
53
54 /**
55 * Starts the output of the dropdown list
56 *
57 * @since 1.2
58 * @since 2.6.7 Use $max_depth and ...$args parameters to follow the move of WP 5.3
59 *
60 * List of parameters accepted in $args:
61 *
62 * flag => display the selected language flag in front of the dropdown if set to 1, defaults to 0
63 * value => the language field to use as value attribute, defaults to 'slug'
64 * selected => the selected value, mandatory
65 * name => the select name attribute, defaults to 'lang_choice'
66 * id => the select id attribute, defaults to $args['name']
67 * class => the class attribute
68 * disabled => disables the dropdown if set to 1
69 *
70 * @param array $elements An array of elements.
71 * @param int $max_depth The maximum hierarchical depth.
72 * @param mixed ...$args Additional arguments.
73 * @return string The hierarchical item output.
74 */
75 public function walk( $elements, $max_depth, ...$args ) { // // phpcs:ignore WordPressVIPMinimum.Classes.DeclarationCompatibility.DeclarationCompatibility
76 $output = '';
77
78 if ( is_array( $max_depth ) ) {
79 // Backward compatibility with Polylang < 2.6.7
80 if ( WP_DEBUG ) {
81 trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions
82 sprintf(
83 '%s was called incorrectly. The method expects an integer as second parameter since Polylang 2.6.7',
84 __METHOD__
85 )
86 );
87 }
88 $args = $max_depth;
89 $max_depth = -1;
90 } else {
91 $args = isset( $args[0] ) ? $args[0] : array();
92 }
93
94 $args = wp_parse_args( $args, array( 'value' => 'slug', 'name' => 'lang_choice' ) );
95
96 if ( ! empty( $args['flag'] ) ) {
97 $current = wp_list_filter( $elements, array( $args['value'] => $args['selected'] ) );
98 $lang = reset( $current );
99 $output = sprintf(
100 '<span class="pll-select-flag">%s</span>',
101 empty( $lang->flag ) ? esc_html( $lang->slug ) : $lang->flag
102 );
103 }
104
105 $output .= sprintf(
106 '<select name="%1$s"%2$s%3$s%4$s>' . "\n" . '%5$s' . "\n" . '</select>' . "\n",
107 esc_attr( $args['name'] ),
108 isset( $args['id'] ) && ! $args['id'] ? '' : ' id="' . ( empty( $args['id'] ) ? esc_attr( $args['name'] ) : esc_attr( $args['id'] ) ) . '"',
109 empty( $args['class'] ) ? '' : ' class="' . esc_attr( $args['class'] ) . '"',
110 disabled( empty( $args['disabled'] ), false, false ),
111 parent::walk( $elements, $max_depth, $args )
112 );
113
114 return $output;
115 }
116 }
117