← All changes | include/widget-languages.php +72 -54 2.7 → 3.7.1 View file →

		@@ -1,10 +1,24 @@
1	1	<?php
	2	+/**
	3	+ * @package Polylang
	4	+ */
2	5
3	6	/**
4	7	* The language switcher widget
5	8	*
6	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	+ * }
7	21	*/
8	22	class PLL_Widget_Languages extends WP_Widget {
9	23
10	24	/**
		@@ -29,28 +43,72 @@
29	43	* @since 0.1
30	44	*
31	45	* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
32	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
33	65	*/
34	66	public function widget( $args, $instance ) {
35		- // Sets a unique id for dropdown
36		- $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 );
37	72
38		- if ( $list = pll_the_languages( array_merge( $instance, array( 'echo' => 0 ) ) ) ) {
	73	+ if ( $list ) {
39	74	$title = empty( $instance['title'] ) ? '' : $instance['title'];
	75	+
40	76	/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
41	77	$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
42	78
43	79	echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
	80	+
44	81	if ( $title ) {
45	82	echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput
46	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	+
47	91	if ( $instance['dropdown'] ) {
48		- 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>';
49	93	echo $list; // phpcs:ignore WordPress.Security.EscapeOutput
50	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	+
51	104	echo "<ul>\n" . $list . "</ul>\n"; // phpcs:ignore WordPress.Security.EscapeOutput
	105	+
	106	+ if ( 'html5' === $format ) {
	107	+ echo '</nav>';
	108	+ }
52	109	}
	110	+
53	111	echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
54	112	}
55	113	}
56	114
		@@ -61,10 +119,13 @@
61	119	*
62	120	* @param array $new_instance New settings for this instance as input by the user via form()
63	121	* @param array $old_instance Old settings for this instance
64	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
65	126	*/
66		- public function update( $new_instance, $old_instance ) {
	127	+ public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
67	128	$instance = array( 'title' => sanitize_text_field( $new_instance['title'] ) );
68	129	foreach ( array_keys( PLL_Switcher::get_switcher_options( 'widget' ) ) as $key ) {
69	130	$instance[ $key ] = ! empty( $new_instance[ $key ] ) ? 1 : 0;
70	131	}
		@@ -72,13 +133,16 @@
72	133	return $instance;
73	134	}
74	135
75	136	/**
76		- * Displays the widget form
	137	+ * Displays the widget form.
77	138	*
78	139	* @since 0.4
79	140	*
80		- * @param array $instance Current settings
	141	+ * @param array $instance Current settings.
	142	+ * @return string
	143	+ *
	144	+ * @phpstan-param T $instance
81	145	*/
82	146	public function form( $instance ) {
83	147	// Default values
84	148	$instance = wp_parse_args( (array) $instance, array_merge( array( 'title' => '' ), PLL_Switcher::get_switcher_options( 'widget', 'default' ) ) );
		@@ -104,53 +168,7 @@
104	168	esc_attr( 'pll-' . $key )
105	169	);
106	170	}
107	171
108		- // FIXME echoing script in form is not very clean
109		- // but it does not work if enqueued properly :
110		- // clicking save on a widget makes this code unreachable for the just saved widget ( ?! )
111		- $this->admin_print_script();
112		- }
113		-
114		- /**
115		- * Add javascript to control the language switcher options
116		- *
117		- * @since 1.3
118		- */
119		- public function admin_print_script() {
120		- static $done = false;
121		-
122		- if ( $done ) {
123		- return;
124		- }
125		-
126		- $done = true;
127		- ?>
128		- <script type='text/javascript'>
129		- //<![CDATA[
130		- jQuery( document ).ready( function( $ ) {
131		- function pll_toggle( a, test ) {
132		- test ? a.show() : a.hide();
133		- }
134		-
135		- // Remove all options if dropdown is checked
136		- $( '.widgets-sortables,.control-section-sidebar' ).on( 'change', '.pll-dropdown', function() {
137		- var this_id = $( this ).parent().parent().parent().children( '.widget-id' ).attr( 'value' );
138		- pll_toggle( $( '.no-dropdown-' + this_id ), 'checked' != $( this ).attr( 'checked' ) );
139		- } );
140		-
141		- // Disallow unchecking both show names and show flags
142		- var options = ['-show_flags', '-show_names'];
143		- $.each( options, function( i, v ) {
144		- $( '.widgets-sortables,.control-section-sidebar' ).on( 'change', '.pll' + v, function() {
145		- var this_id = $( this ).parent().parent().parent().children( '.widget-id' ).attr( 'value' );
146		- if ( 'checked' != $( this ).attr( 'checked' ) ) {
147		- $( '#widget-' + this_id + options[ 1-i ] ).prop( 'checked', true );
148		- }
149		- } );
150		- } );
151		- } );
152		- //]]>
153		- </script>
154		- <?php
	172	+ return ''; // Because the parent class returns a string, however not used.
155	173	}
156	174	}