PluginProbe
Polylang / 3.6.7
Polylang v3.6.7
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
← All changes | admin/admin-base.php +158 -54 3.0.13.6.7 View file →
@@ -11,9 +11,9 @@
11 11 abstract class PLL_Admin_Base extends PLL_Base {
12 12 /**
13 13 * Current language (used to filter the content).
14 14 *
15 - * @var PLL_Language
15 + * @var PLL_Language|null
16 16 */
17 17 public $curlang;
18 18
19 19 /**
@@ -18,9 +18,9 @@
18 18
19 19 /**
20 20 * Language selected in the admin language filter.
21 21 *
22 - * @var PLL_Language
22 + * @var PLL_Language|null
23 23 */
24 24 public $filter_lang;
25 25
26 26 /**
@@ -25,33 +25,38 @@
25 25
26 26 /**
27 27 * Preferred language to assign to new contents.
28 28 *
29 - * @var PLL_Language
29 + * @var PLL_Language|null
30 30 */
31 31 public $pref_lang;
32 32
33 33 /**
34 - * @var PLL_Filters_Links
34 + * @var PLL_Filters_Links|null
35 35 */
36 36 public $filters_links;
37 37
38 38 /**
39 - * @var PLL_Admin_Links
39 + * @var PLL_Admin_Links|null
40 40 */
41 41 public $links;
42 42
43 43 /**
44 - * @var PLL_Admin_Notices
44 + * @var PLL_Admin_Notices|null
45 45 */
46 46 public $notices;
47 47
48 48 /**
49 - * @var PLL_Admin_Static_Pages
49 + * @var PLL_Admin_Static_Pages|null
50 50 */
51 51 public $static_pages;
52 52
53 53 /**
54 + * @var PLL_Admin_Default_Term|null
55 + */
56 + public $default_term;
57 +
58 + /**
54 59 * Setups actions needed on all admin pages.
55 60 *
56 61 * @since 1.8
57 62 *
@@ -62,13 +67,19 @@
62 67
63 68 // Adds the link to the languages panel in the WordPress admin menu
64 69 add_action( 'admin_menu', array( $this, 'add_menus' ) );
65 70
71 + add_action( 'admin_menu', array( $this, 'remove_customize_submenu' ) );
72 +
66 73 // Setup js scripts and css styles
67 74 add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
68 75 add_action( 'admin_print_footer_scripts', array( $this, 'admin_print_footer_scripts' ), 0 ); // High priority in case an ajax request is sent by an immediately invoked function
69 76
70 77 add_action( 'customize_controls_enqueue_scripts', array( $this, 'customize_controls_enqueue_scripts' ) );
78 +
79 + // Early instantiated to be able to correctly initialize language properties.
80 + $this->static_pages = new PLL_Admin_Static_Pages( $this );
81 + $this->model->set_languages_ready();
71 82 }
72 83
73 84 /**
74 85 * Setups filters and action needed on all admin pages and on plugins page
@@ -80,14 +91,16 @@
80 91 parent::init();
81 92
82 93 $this->notices = new PLL_Admin_Notices( $this );
83 94
84 - if ( ! $this->model->get_languages_list() ) {
95 + $this->default_term = new PLL_Admin_Default_Term( $this );
96 + $this->default_term->add_hooks();
97 +
98 + if ( ! $this->model->has_languages() ) {
85 99 return;
86 100 }
87 101
88 102 $this->links = new PLL_Admin_Links( $this ); // FIXME needed here ?
89 - $this->static_pages = new PLL_Admin_Static_Pages( $this ); // FIXME needed here ?
90 103 $this->filters_links = new PLL_Filters_Links( $this ); // FIXME needed here ?
91 104
92 105 // Filter admin language for users
93 106 // We must not call user info before WordPress defines user roles in wp-settings.php
@@ -111,10 +124,10 @@
111 124 // Prepare the list of tabs
112 125 $tabs = array( 'lang' => __( 'Languages', 'polylang' ) );
113 126
114 127 // Only if at least one language has been created
115 - if ( $this->model->get_languages_list() ) {
116 - $tabs['strings'] = __( 'Strings translations', 'polylang' );
128 + if ( $this->model->has_languages() ) {
129 + $tabs['strings'] = __( 'Translations', 'polylang' );
117 130 }
118 131
119 132 $tabs['settings'] = __( 'Settings', 'polylang' );
120 133
@@ -159,47 +172,67 @@
159 172 /*
160 173 * For each script:
161 174 * 0 => the pages on which to load the script
162 175 * 1 => the scripts it needs to work
163 - * 2 => 1 if loaded even if languages have not been defined yet, 0 otherwise
164 - * 3 => 1 if loaded in footer
176 + * 2 => true if loaded even if languages have not been defined yet, false otherwise
177 + * 3 => true if loaded in footer
165 178 */
166 179 $scripts = array(
167 - 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), 0, 0 ),
168 - 'widgets' => array( array( 'widgets' ), array( 'jquery' ), 0, 0 ),
180 + 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), false, false ),
181 + 'widgets' => array( array( 'widgets' ), array( 'jquery' ), false, false ),
169 182 );
170 183
184 + $block_screens = array( 'widgets', 'site-editor' );
185 +
171 186 if ( ! empty( $screen->post_type ) && $this->model->is_translated_post_type( $screen->post_type ) ) {
172 - $scripts['post'] = array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), 0, 1 );
187 + $scripts['post'] = array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), false, true );
173 188
174 189 // Classic editor.
175 190 if ( ! method_exists( $screen, 'is_block_editor' ) || ! $screen->is_block_editor() ) {
176 - $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post', 'jquery-ui-dialog', 'wp-i18n' ), 0, 1 );
191 + $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post', 'jquery-ui-dialog', 'wp-i18n' ), false, true );
177 192 }
178 193
179 194 // Block editor with legacy metabox in WP 5.0+.
180 - if ( method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin() ) {
181 - $scripts['block-editor'] = array( array( 'post' ), array( 'jquery', 'wp-ajax-response', 'wp-api-fetch', 'jquery-ui-dialog', 'wp-i18n' ), 0, 1 );
182 - }
195 + $block_screens[] = 'post';
183 196 }
184 197
198 + if ( $this->is_block_editor( $screen ) ) {
199 + $scripts['block-editor'] = array( $block_screens, array( 'jquery', 'wp-ajax-response', 'wp-api-fetch', 'jquery-ui-dialog', 'wp-i18n' ), false, true );
200 + }
201 +
185 202 if ( ! empty( $screen->taxonomy ) && $this->model->is_translated_taxonomy( $screen->taxonomy ) ) {
186 - $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), 0, 1 );
203 + $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), false, true );
187 204 }
188 205
189 206 foreach ( $scripts as $script => $v ) {
190 - if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->get_languages_list() ) ) {
191 - wp_enqueue_script( 'pll_' . $script, plugins_url( '/js/build/' . $script . $suffix . '.js', POLYLANG_BASENAME ), $v[1], POLYLANG_VERSION, $v[3] );
207 + if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->has_languages() ) ) {
208 + wp_enqueue_script( 'pll_' . $script, plugins_url( '/js/build/' . $script . $suffix . '.js', POLYLANG_ROOT_FILE ), $v[1], POLYLANG_VERSION, $v[3] );
209 + if ( 'classic-editor' === $script || 'block-editor' === $script ) {
210 + wp_set_script_translations( 'pll_' . $script, 'polylang' );
211 + }
192 212 }
193 213 }
194 214
195 - wp_register_style( 'polylang_admin', plugins_url( '/css/build/admin' . $suffix . '.css', POLYLANG_BASENAME ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION );
196 - wp_enqueue_style( 'polylang_dialog', plugins_url( '/css/build/dialog' . $suffix . '.css', POLYLANG_BASENAME ), array( 'polylang_admin' ), POLYLANG_VERSION );
215 + wp_register_style( 'polylang_admin', plugins_url( '/css/build/admin' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION );
216 + wp_enqueue_style( 'polylang_dialog', plugins_url( '/css/build/dialog' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'polylang_admin' ), POLYLANG_VERSION );
197 217
198 - $this->localize_scripts();
218 + $this->add_inline_scripts();
199 219 }
200 220
201 221 /**
222 + * Tells whether or not the given screen is block editor kind.
223 + * e.g. widget, site or post editor.
224 + *
225 + * @since 3.3
226 + *
227 + * @param WP_Screen $screen Screen object.
228 + * @return bool True if the screen is a block editor, false otherwise.
229 + */
230 + protected function is_block_editor( $screen ) {
231 + return method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin();
232 + }
233 +
234 + /**
202 235 * Enqueue scripts to the WP Customizer.
203 236 *
204 237 * @since 2.4.0
205 238 *
@@ -205,23 +238,32 @@
205 238 *
206 239 * @return void
207 240 */
208 241 public function customize_controls_enqueue_scripts() {
209 - if ( $this->model->get_languages_list() ) {
242 + if ( $this->model->has_languages() ) {
210 243 $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
211 - wp_enqueue_script( 'pll_widgets', plugins_url( '/js/build/widgets' . $suffix . '.js', POLYLANG_BASENAME ), array( 'jquery' ), POLYLANG_VERSION, true );
212 - $this->localize_scripts();
244 + wp_enqueue_script( 'pll_widgets', plugins_url( '/js/build/widgets' . $suffix . '.js', POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true );
245 + $this->add_inline_scripts();
213 246 }
214 247 }
215 248
216 249 /**
217 - * Localize scripts.
250 + * Adds inline scripts to set the default language in JS
251 + * and localizes scripts.
218 252 *
219 - * @since 2.4.0
253 + * @since 3.3
220 254 *
221 255 * @return void
222 256 */
223 - public function localize_scripts() {
257 + private function add_inline_scripts() {
258 + if ( wp_script_is( 'pll_block-editor', 'enqueued' ) ) {
259 + $default_lang_script = 'const pllDefaultLanguage = "' . $this->options['default_lang'] . '";';
260 + wp_add_inline_script(
261 + 'pll_block-editor',
262 + $default_lang_script,
263 + 'before'
264 + );
265 + }
224 266 if ( wp_script_is( 'pll_widgets', 'enqueued' ) ) {
225 267 wp_localize_script(
226 268 'pll_widgets',
227 269 'pll_widgets',
@@ -259,12 +301,21 @@
259 301 if ( ! empty( $tag_ID ) ) {
260 302 $params = array_merge( $params, array( 'pll_term_id' => (int) $tag_ID ) );
261 303 }
262 304
305 + /**
306 + * Filters the list of parameters to add to the admin ajax request.
307 + *
308 + * @since 3.4.5
309 + *
310 + * @param array $params List of parameters to add to the admin ajax request.
311 + */
312 + $params = apply_filters( 'pll_admin_ajax_params', $params );
313 +
263 314 $str = http_build_query( $params );
264 315 $arr = wp_json_encode( $params );
265 316 ?>
266 - <script type="text/javascript">
317 + <script>
267 318 if (typeof jQuery != 'undefined') {
268 319 jQuery(
269 320 function( $ ){
270 321 $.ajaxPrefilter( function ( options, originalOptions, jqXHR ) {
@@ -269,13 +320,23 @@
269 320 function( $ ){
270 321 $.ajaxPrefilter( function ( options, originalOptions, jqXHR ) {
271 322 if ( -1 != options.url.indexOf( ajaxurl ) || -1 != ajaxurl.indexOf( options.url ) ) {
272 323
273 - function addStringParameters() {
274 - if ( 'undefined' === typeof options.data || '' === options.data ) {
324 + function addPolylangParametersAsString() {
325 + if ( 'undefined' === typeof options.data || '' === options.data.trim() ) {
326 + // Only Polylang data need to be send. So it could be as a simple query string.
275 327 options.data = '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>';
276 328 } else {
277 - options.data = options.data + '&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>';
329 + /*
330 + * In some cases data could be a JSON string like in third party plugins.
331 + * So we need not to break their process by adding polylang parameters as valid JSON data.
332 + */
333 + try {
334 + options.data = JSON.stringify( Object.assign( JSON.parse( options.data ), <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> ) );
335 + } catch( exception ) {
336 + // Add Polylang data to the existing query string.
337 + options.data = options.data + '&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>';
338 + }
278 339 }
279 340 }
280 341
281 342 /*
@@ -281,11 +342,14 @@
281 342 /*
282 343 * options.processData set to true is the default jQuery process where the data is converted in a query string by using jQuery.param().
283 344 * This step is done before applying filters. Thus here the options.data is already a string in this case.
284 345 * @See https://github.com/jquery/jquery/blob/3.5.1/src/ajax.js#L563-L569 jQuery ajax function.
346 + * It is the most case WordPress send ajax request this way however third party plugins or themes could be send JSON string.
347 + * Use JSON format is recommended in jQuery.param() documentation to be able to send complex data structures.
348 + * @See https://api.jquery.com/jquery.param/ jQuery param function.
285 349 */
286 350 if ( options.processData ) {
287 - addStringParameters();
351 + addPolylangParametersAsString();
288 352 } else {
289 353 /*
290 354 * If options.processData is set to false data could be undefined or pass as a string.
291 355 * So data as to be processed as if options.processData is set to true.
@@ -290,12 +354,12 @@
290 354 * If options.processData is set to false data could be undefined or pass as a string.
291 355 * So data as to be processed as if options.processData is set to true.
292 356 */
293 357 if ( 'undefined' === typeof options.data || 'string' === typeof options.data ) {
294 - addStringParameters();
358 + addPolylangParametersAsString();
295 359 } else {
296 360 // Otherwise options.data is probably an object.
297 - options.data = Object.assign( options.data, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> );
361 + options.data = Object.assign( options.data || {} , <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> );
298 362 }
299 363 }
300 364 }
301 365 });
@@ -342,10 +406,20 @@
342 406 if ( wp_doing_ajax() && ! empty( $_REQUEST['lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
343 407 $this->curlang = $this->model->get_language( sanitize_key( $_REQUEST['lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
344 408 }
345 409
410 + /**
411 + * Filters the current language used by Polylang in the admin context.
412 + *
413 + * @since 3.2
414 + *
415 + * @param PLL_Language|false|null $curlang Instance of the current language.
416 + * @param PLL_Admin_Base $polylang Instance of the main Polylang's object.
417 + */
418 + $this->curlang = apply_filters( 'pll_admin_current_language', $this->curlang, $this );
419 +
346 420 // Inform that the admin language has been set.
347 - if ( $this->curlang ) {
421 + if ( $this->curlang instanceof PLL_Language ) {
348 422 /** This action is documented in frontend/choose-lang.php */
349 423 do_action( 'pll_language_defined', $this->curlang->slug, $this->curlang );
350 424 } else {
351 425 /** This action is documented in include/class-polylang.php */
@@ -370,9 +444,9 @@
370 444
371 445 $this->filter_lang = $this->model->get_language( get_user_meta( get_current_user_id(), 'pll_filter_content', true ) );
372 446
373 447 // Set preferred language for use when saving posts and terms: must not be empty
374 - $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_language( $this->options['default_lang'] ) : $this->filter_lang;
448 + $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_default_language() : $this->filter_lang;
375 449
376 450 /**
377 451 * Filters the preferred language on admin side.
378 452 * The preferred language is used for example to determine the language of a new post.
@@ -383,11 +457,8 @@
383 457 */
384 458 $this->pref_lang = apply_filters( 'pll_admin_preferred_language', $this->pref_lang );
385 459
386 460 $this->set_current_language();
387 -
388 - // Plugin i18n, only needed for backend.
389 - load_plugin_textdomain( 'polylang' );
390 461 }
391 462
392 463 /**
393 464 * Avoids parsing a tax query when all languages are requested
@@ -396,9 +467,9 @@
396 467 * @see https://core.trac.wordpress.org/ticket/31246 the suggestion of @boonebgorges.
397 468 *
398 469 * @since 1.6.5
399 470 *
400 - * @param array $qvars
471 + * @param array $qvars The array of requested query variables.
401 472 * @return array
402 473 */
403 474 public function request( $qvars ) {
404 475 if ( isset( $qvars['lang'] ) && 'all' === $qvars['lang'] ) {
@@ -426,9 +497,9 @@
426 497 $selected = empty( $this->filter_lang ) ? $all_item : $this->filter_lang;
427 498
428 499 $title = sprintf(
429 500 '<span class="ab-label"%1$s><span class="screen-reader-text">%2$s</span>%3$s</span>',
430 - 'all' === $selected->slug ? '' : sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ),
501 + $selected instanceof PLL_Language ? sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ) : '',
431 502 __( 'Filters content by language', 'polylang' ),
432 503 esc_html( $selected->name )
433 504 );
434 505
@@ -440,17 +511,23 @@
440 511 * @param array $items The admin languages filter submenu items.
441 512 */
442 513 $items = apply_filters( 'pll_admin_languages_filter', array_merge( array( $all_item ), $this->model->get_languages_list() ) );
443 514
515 + $menu = array(
516 + 'id' => 'languages',
517 + 'title' => $selected->flag . $title,
518 + 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ),
519 + 'meta' => array(
520 + 'title' => __( 'Filters content by language', 'polylang' ),
521 + ),
522 + );
523 +
524 + if ( 'all' !== $selected->slug ) {
525 + $menu['meta']['class'] = 'pll-filtered-languages';
526 + }
527 +
444 528 if ( ! empty( $items ) ) {
445 - $wp_admin_bar->add_menu(
446 - array(
447 - 'id' => 'languages',
448 - 'title' => $selected->flag . $title,
449 - 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ),
450 - 'meta' => array( 'title' => __( 'Filters content by language', 'polylang' ) ),
451 - )
452 - );
529 + $wp_admin_bar->add_menu( $menu );
453 530 }
454 531
455 532 foreach ( $items as $lang ) {
456 533 if ( $selected->slug === $lang->slug ) {
@@ -465,7 +542,34 @@
465 542 'href' => esc_url( add_query_arg( 'lang', $lang->slug, remove_query_arg( 'paged' ) ) ),
466 543 'meta' => 'all' === $lang->slug ? array() : array( 'lang' => esc_attr( $lang->get_locale( 'display' ) ) ),
467 544 )
468 545 );
546 + }
547 + }
548 +
549 + /**
550 + * Remove the customize submenu when using a block theme.
551 + *
552 + * WordPress removes the Customizer menu if a block theme is activated and no other plugins interact with it.
553 + * As Polylang interacts with the Customizer, we have to delete this menu ourselves in the case of a block theme,
554 + * unless another plugin than Polylang interacts with the Customizer.
555 + *
556 + * @since 3.2
557 + *
558 + * @return void
559 + */
560 + public function remove_customize_submenu() {
561 + if ( ! $this->should_customize_menu_be_removed() ) {
562 + return;
563 + }
564 +
565 + global $submenu;
566 +
567 + if ( ! empty( $submenu['themes.php'] ) ) {
568 + foreach ( $submenu['themes.php'] as $submenu_item ) {
569 + if ( 'customize' === $submenu_item[1] ) {
570 + remove_submenu_page( 'themes.php', $submenu_item[2] );
571 + }
572 + }
469 573 }
470 574 }
471 575 }