← All changes | include/widget-languages.php +69 -54 2.8 → 3.7.7 View file →

		@@ -6,8 +6,19 @@
6	6	/**
7	7	* The language switcher widget
8	8	*
9	9	* @since 0.1
	10	+ *
	11	+ * @extends WP_Widget<T>
	12	+ * @phpstan-template T of array{
	13	+ * title: string,
	14	+ * dropdown: 0|1,
	15	+ * show_names: 0|1,
	16	+ * show_flags: 0|1,
	17	+ * force_home: 0|1,
	18	+ * hide_current: 0|1,
	19	+ * hide_if_no_translation: 0|1
	20	+ * }
10	21	*/
11	22	class PLL_Widget_Languages extends WP_Widget {
12	23
13	24	/**
		@@ -32,28 +43,72 @@
32	43	* @since 0.1
33	44	*
34	45	* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
35	46	* @param array $instance The settings for the particular instance of the widget
	47	+ * @return void
	48	+ *
	49	+ * @phpstan-param array{
	50	+ * name: string,
	51	+ * id: string,
	52	+ * description: string,
	53	+ * class: string,
	54	+ * before_widget: string,
	55	+ * after_widget: string,
	56	+ * before_title: string,
	57	+ * after_title: string,
	58	+ * before_sidebar: string,
	59	+ * after_sidebar: string,
	60	+ * show_in_rest: boolean,
	61	+ * widget_id: string,
	62	+ * widget_name: string
	63	+ * } $args
	64	+ * @phpstan-param T $instance
36	65	*/
37	66	public function widget( $args, $instance ) {
38		- // Sets a unique id for dropdown
39		- $instance['dropdown'] = empty( $instance['dropdown'] ) ? 0 : $args['widget_id'];
	67	+ // Sets a unique id for dropdown.
	68	+ $instance['dropdown'] = empty( $instance['dropdown'] ) ? 0 : $this->id;
	69	+ $instance['echo'] = 0;
	70	+ $instance['raw'] = 0;
	71	+ $list = pll_the_languages( $instance );
40	72
41		- if ( $list = pll_the_languages( array_merge( $instance, array( 'echo' => 0 ) ) ) ) {
	73	+ if ( $list ) {
42	74	$title = empty( $instance['title'] ) ? '' : $instance['title'];
	75	+
43	76	/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
44	77	$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
45	78
46	79	echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
	80	+
47	81	if ( $title ) {
48	82	echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput
49	83	}
	84	+
	85	+ // The title may be filtered: Strip out HTML and make sure the aria-label is never empty.
	86	+ $aria_label = trim( wp_strip_all_tags( $title ) );
	87	+ if ( ! $aria_label ) {
	88	+ $aria_label = __( 'Choose a language', 'polylang' );
	89	+ }
	90	+
50	91	if ( $instance['dropdown'] ) {
51		- echo '<label class="screen-reader-text" for="' . esc_attr( 'lang_choice_' . $instance['dropdown'] ) . '">' . esc_html__( 'Choose a language', 'polylang' ) . '</label>';
	92	+ echo '<label class="screen-reader-text" for="' . esc_attr( 'lang_choice_' . $instance['dropdown'] ) . '">' . esc_html( $aria_label ) . '</label>';
52	93	echo $list; // phpcs:ignore WordPress.Security.EscapeOutput
53	94	} else {
	95	+ $format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';
	96	+
	97	+ /** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */
	98	+ $format = apply_filters( 'navigation_widgets_format', $format );
	99	+
	100	+ if ( 'html5' === $format ) {
	101	+ echo '<nav aria-label="' . esc_attr( $aria_label ) . '">';
	102	+ }
	103	+
54	104	echo "<ul>\n" . $list . "</ul>\n"; // phpcs:ignore WordPress.Security.EscapeOutput
	105	+
	106	+ if ( 'html5' === $format ) {
	107	+ echo '</nav>';
	108	+ }
55	109	}
	110	+
56	111	echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
57	112	}
58	113	}
59	114
		@@ -64,10 +119,13 @@
64	119	*
65	120	* @param array $new_instance New settings for this instance as input by the user via form()
66	121	* @param array $old_instance Old settings for this instance
67	122	* @return array Settings to save or bool false to cancel saving
	123	+ *
	124	+ * @phpstan-param T $new_instance
	125	+ * @phpstan-param T $old_instance
68	126	*/
69		- public function update( $new_instance, $old_instance ) {
	127	+ public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
70	128	$instance = array( 'title' => sanitize_text_field( $new_instance['title'] ) );
71	129	foreach ( array_keys( PLL_Switcher::get_switcher_options( 'widget' ) ) as $key ) {
72	130	$instance[ $key ] = ! empty( $new_instance[ $key ] ) ? 1 : 0;
73	131	}
		@@ -75,13 +133,16 @@
75	133	return $instance;
76	134	}
77	135
78	136	/**
79		- * Displays the widget form
	137	+ * Displays the widget form.
80	138	*
81	139	* @since 0.4
82	140	*
83		- * @param array $instance Current settings
	141	+ * @param array $instance Current settings.
	142	+ * @return string
	143	+ *
	144	+ * @phpstan-param T $instance
84	145	*/
85	146	public function form( $instance ) {
86	147	// Default values
87	148	$instance = wp_parse_args( (array) $instance, array_merge( array( 'title' => '' ), PLL_Switcher::get_switcher_options( 'widget', 'default' ) ) );
		@@ -107,53 +168,7 @@
107	168	esc_attr( 'pll-' . $key )
108	169	);
109	170	}
110	171
111		- // FIXME echoing script in form is not very clean
112		- // but it does not work if enqueued properly :
113		- // clicking save on a widget makes this code unreachable for the just saved widget ( ?! )
114		- $this->admin_print_script();
115		- }
116		-
117		- /**
118		- * Add javascript to control the language switcher options
119		- *
120		- * @since 1.3
121		- */
122		- public function admin_print_script() {
123		- static $done = false;
124		-
125		- if ( $done ) {
126		- return;
127		- }
128		-
129		- $done = true;
130		- ?>
131		- <script type='text/javascript'>
132		- //<![CDATA[
133		- jQuery( document ).ready( function( $ ) {
134		- function pll_toggle( a, test ) {
135		- test ? a.show() : a.hide();
136		- }
137		-
138		- // Remove all options if dropdown is checked
139		- $( '.widgets-sortables,.control-section-sidebar' ).on( 'change', '.pll-dropdown', function() {
140		- var this_id = $( this ).parent().parent().parent().children( '.widget-id' ).attr( 'value' );
141		- pll_toggle( $( '.no-dropdown-' + this_id ), true != $( this ).prop( 'checked' ) );
142		- } );
143		-
144		- // Disallow unchecking both show names and show flags
145		- var options = ['-show_flags', '-show_names'];
146		- $.each( options, function( i, v ) {
147		- $( '.widgets-sortables,.control-section-sidebar' ).on( 'change', '.pll' + v, function() {
148		- var this_id = $( this ).parent().parent().parent().children( '.widget-id' ).attr( 'value' );
149		- if ( true != $( this ).prop( 'checked' ) ) {
150		- $( '#widget-' + this_id + options[ 1-i ] ).prop( 'checked', true );
151		- }
152		- } );
153		- } );
154		- } );
155		- //]]>
156		- </script>
157		- <?php
	172	+ return ''; // Because the parent class returns a string, however not used.
158	173	}
159	174	}