← All changes | include/walker-dropdown.php +39 -47 2.7.2 → 3.7.7 View file →

		@@ -1,52 +1,56 @@
1	1	<?php
	2	+/**
	3	+ * @package Polylang
	4	+ */
2	5
3	6	/**
4	7	* Displays languages in a dropdown list
5	8	*
6	9	* @since 1.2
	10	+ * @since 3.4 Extends `PLL_Walker` now.
7	11	*/
8		-class PLL_Walker_Dropdown extends Walker {
9		- public $db_fields = array( 'parent' => 'parent', 'id' => 'id' );
10		-
	12	+class PLL_Walker_Dropdown extends PLL_Walker {
11	13	/**
12		- * Outputs one element
	14	+ * Database fields to use.
13	15	*
14		- * @since 1.2
	16	+ * @see https://developer.wordpress.org/reference/classes/walker/#properties Walker::$db_fields.
15	17	*
16		- * @param string $output Passed by reference. Used to append additional content.
17		- * @param object $element The data object.
18		- * @param int $depth Depth of the item.
19		- * @param array $args An array of additional arguments.
20		- * @param int $current_object_id ID of the current item.
	18	+ * @var string[]
21	19	*/
22		- public function start_el( &$output, $element, $depth = 0, $args = array(), $current_object_id = 0 ) {
23		- $value = $args['value'];
24		- $output .= sprintf(
25		- "\t" . '<option value="%1$s"%2$s%3$s>%4$s</option>' . "\n",
26		- esc_attr( $element->$value ),
27		- method_exists( $element, 'get_locale' ) ? sprintf( ' lang="%s"', esc_attr( $element->get_locale( 'display' ) ) ) : '',
28		- selected( isset( $args['selected'] ) && $args['selected'] === $element->$value, true, false ),
29		- esc_html( $element->name )
30		- );
31		- }
	20	+ public $db_fields = array( 'parent' => 'parent', 'id' => 'id' );
32	21
33	22	/**
34		- * Overrides Walker::display_element as expects an object with a parent property
	23	+ * Outputs one element.
35	24	*
36	25	* @since 1.2
37	26	*
38		- * @param object $element Data object.
39		- * @param array $children_elements List of elements to continue traversing.
40		- * @param int $max_depth Max depth to traverse.
41		- * @param int $depth Depth of current element.
42		- * @param array $args An array of arguments.
43		- * @param string $output Passed by reference. Used to append additional content.
	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
44	33	*/
45		- public function display_element( $element, &$children_elements, $max_depth, $depth = 0, $args, &$output ) {
46		- $element = (object) $element; // Make sure we have an object
47		- $element->parent = $element->id = 0; // Don't care about this
48		- parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
	34	+ public function start_el( &$output, $element, $depth = 0, $args = array(), $current_object_id = 0 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	35	+ $value_type = $args['value'];
	36	+
	37	+ // Some data from the language object to be passed as HTML data attributes for fetching in JS.
	38	+ $data_lang = array(
	39	+ 'id' => $element->id,
	40	+ 'name' => $element->name,
	41	+ 'slug' => $element->slug,
	42	+ 'dir' => $element->is_rtl ?? '',
	43	+ );
	44	+
	45	+ $output .= sprintf(
	46	+ "\t" . '<option value="%1$s"%2$s%3$s data-lang="%5$s">%4$s</option>' . "\n",
	47	+ 'url' === $value_type ? esc_url( $element->$value_type ) : esc_attr( $element->$value_type ),
	48	+ ! empty( $element->locale ) ? sprintf( ' lang="%s"', esc_attr( $element->locale ) ) : '',
	49	+ selected( isset( $args['selected'] ) && $args['selected'] === $element->$value_type, true, false ),
	50	+ esc_html( $element->name ),
	51	+ esc_html( (string) wp_json_encode( $data_lang ) )
	52	+ );
49	53	}
50	54
51	55	/**
52	56	* Starts the output of the dropdown list
		@@ -63,31 +67,19 @@
63	67	* id => the select id attribute, defaults to $args['name']
64	68	* class => the class attribute
65	69	* disabled => disables the dropdown if set to 1
66	70	*
67		- * @param array $elements An array of elements.
	71	+ * @param array $elements An array of `PLL_language` or `stdClass` elements.
68	72	* @param int $max_depth The maximum hierarchical depth.
69	73	* @param mixed ...$args Additional arguments.
70	74	* @return string The hierarchical item output.
	75	+ *
	76	+ * @phpstan-param array<PLL_Language|stdClass> $elements
71	77	*/
72	78	public function walk( $elements, $max_depth, ...$args ) { // // phpcs:ignore WordPressVIPMinimum.Classes.DeclarationCompatibility.DeclarationCompatibility
73	79	$output = '';
74	80
75		- if ( is_array( $max_depth ) ) {
76		- // Backward compatibility with Polylang < 2.6.7
77		- if ( WP_DEBUG ) {
78		- trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions
79		- sprintf(
80		- '%s was called incorrectly. The method expects an integer as second parameter since Polylang 2.6.7',
81		- __METHOD__
82		- )
83		- );
84		- }
85		- $args = $max_depth;
86		- $max_depth = -1;
87		- } else {
88		- $args = isset( $args[0] ) ? $args[0] : array();
89		- }
	81	+ $this->maybe_fix_walk_args( $max_depth, $args );
90	82
91	83	$args = wp_parse_args( $args, array( 'value' => 'slug', 'name' => 'lang_choice' ) );
92	84
93	85	if ( ! empty( $args['flag'] ) ) {