PluginProbe
Polylang / 3.7.1
Polylang v3.7.1
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 +162 -119 3.0.33.7.1 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,18 @@
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 - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
68 - 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
74 + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ), 0 ); // High priority in case an ajax request is sent by an immediately invoked function
69 75
70 76 add_action( 'customize_controls_enqueue_scripts', array( $this, 'customize_controls_enqueue_scripts' ) );
77 +
78 + // Early instantiated to be able to correctly initialize language properties.
79 + $this->static_pages = new PLL_Admin_Static_Pages( $this );
80 + $this->model->set_languages_ready();
71 81 }
72 82
73 83 /**
74 84 * Setups filters and action needed on all admin pages and on plugins page
@@ -80,14 +90,16 @@
80 90 parent::init();
81 91
82 92 $this->notices = new PLL_Admin_Notices( $this );
83 93
84 - if ( ! $this->model->get_languages_list() ) {
94 + $this->default_term = new PLL_Admin_Default_Term( $this );
95 + $this->default_term->add_hooks();
96 +
97 + if ( ! $this->model->has_languages() ) {
85 98 return;
86 99 }
87 100
88 101 $this->links = new PLL_Admin_Links( $this ); // FIXME needed here ?
89 - $this->static_pages = new PLL_Admin_Static_Pages( $this ); // FIXME needed here ?
90 102 $this->filters_links = new PLL_Filters_Links( $this ); // FIXME needed here ?
91 103
92 104 // Filter admin language for users
93 105 // We must not call user info before WordPress defines user roles in wp-settings.php
@@ -111,10 +123,10 @@
111 123 // Prepare the list of tabs
112 124 $tabs = array( 'lang' => __( 'Languages', 'polylang' ) );
113 125
114 126 // Only if at least one language has been created
115 - if ( $this->model->get_languages_list() ) {
116 - $tabs['strings'] = __( 'Strings translations', 'polylang' );
127 + if ( $this->model->has_languages() ) {
128 + $tabs['strings'] = __( 'Translations', 'polylang' );
117 129 }
118 130
119 131 $tabs['settings'] = __( 'Settings', 'polylang' );
120 132
@@ -141,8 +153,18 @@
141 153 }
142 154 }
143 155
144 156 /**
157 + * Dummy method to display the 3 tabs pages: languages, strings translations, settings.
158 + * Overwritten in `PLL_Settings`.
159 + *
160 + * @since 3.7
161 + *
162 + * @return void
163 + */
164 + public function languages_page() {}
165 +
166 + /**
145 167 * Setup js scripts & css styles ( only on the relevant pages )
146 168 *
147 169 * @since 0.6
148 170 *
@@ -148,61 +170,82 @@
148 170 *
149 171 * @return void
150 172 */
151 173 public function admin_enqueue_scripts() {
174 + $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
175 +
176 + wp_enqueue_script( 'pll_admin', plugins_url( "/js/build/admin{$suffix}.js", POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true );
177 + $inline_script = sprintf( 'let pll_admin = %s;', wp_json_encode( array( 'ajax_filter' => $this->get_ajax_filter_data() ) ) );
178 + wp_add_inline_script( 'pll_admin', $inline_script, 'before' );
179 +
152 180 $screen = get_current_screen();
153 181 if ( empty( $screen ) ) {
154 182 return;
155 183 }
156 184
157 - $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
158 -
159 185 /*
160 186 * For each script:
161 187 * 0 => the pages on which to load the script
162 188 * 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
189 + * 2 => true if loaded even if languages have not been defined yet, false otherwise
190 + * 3 => true if loaded in footer
165 191 */
166 192 $scripts = array(
167 - 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), 0, 0 ),
168 - 'widgets' => array( array( 'widgets' ), array( 'jquery' ), 0, 0 ),
193 + 'user' => array( array( 'profile', 'user-edit' ), array( 'jquery' ), false, false ),
194 + 'widgets' => array( array( 'widgets' ), array( 'jquery' ), false, false ),
169 195 );
170 196
197 + $block_screens = array( 'widgets', 'site-editor' );
198 +
171 199 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 );
200 + $scripts['post'] = array( array( 'edit', 'upload' ), array( 'jquery', 'wp-ajax-response' ), false, true );
173 201
174 202 // Classic editor.
175 203 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 );
204 + $scripts['classic-editor'] = array( array( 'post', 'media', 'async-upload' ), array( 'jquery', 'wp-ajax-response', 'post', 'jquery-ui-dialog', 'wp-i18n' ), false, true );
177 205 }
178 206
179 207 // 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 - }
208 + $block_screens[] = 'post';
183 209 }
184 210
211 + if ( $this->is_block_editor( $screen ) ) {
212 + $scripts['block-editor'] = array( $block_screens, array( 'jquery', 'wp-ajax-response', 'wp-api-fetch', 'jquery-ui-dialog', 'wp-i18n' ), false, true );
213 + }
214 +
185 215 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 );
216 + $scripts['term'] = array( array( 'edit-tags', 'term' ), array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), false, true );
187 217 }
188 218
189 219 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_ROOT_FILE ), $v[1], POLYLANG_VERSION, $v[3] );
220 + if ( in_array( $screen->base, $v[0] ) && ( $v[2] || $this->model->has_languages() ) ) {
221 + wp_enqueue_script( "pll_{$script}", plugins_url( "/js/build/{$script}{$suffix}.js", POLYLANG_ROOT_FILE ), $v[1], POLYLANG_VERSION, $v[3] );
192 222 if ( 'classic-editor' === $script || 'block-editor' === $script ) {
193 - wp_set_script_translations( 'pll_' . $script, 'polylang' );
223 + wp_set_script_translations( "pll_{$script}", 'polylang' );
194 224 }
195 225 }
196 226 }
197 227
198 - wp_register_style( 'polylang_admin', plugins_url( '/css/build/admin' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION );
199 - wp_enqueue_style( 'polylang_dialog', plugins_url( '/css/build/dialog' . $suffix . '.css', POLYLANG_ROOT_FILE ), array( 'polylang_admin' ), POLYLANG_VERSION );
228 + wp_register_style( 'polylang_admin', plugins_url( "/css/build/admin{$suffix}.css", POLYLANG_ROOT_FILE ), array( 'wp-jquery-ui-dialog' ), POLYLANG_VERSION );
229 + wp_enqueue_style( 'polylang_dialog', plugins_url( "/css/build/dialog{$suffix}.css", POLYLANG_ROOT_FILE ), array( 'polylang_admin' ), POLYLANG_VERSION );
200 230
201 - $this->localize_scripts();
231 + $this->add_inline_scripts();
202 232 }
203 233
204 234 /**
235 + * Tells whether or not the given screen is block editor kind.
236 + * e.g. widget, site or post editor.
237 + *
238 + * @since 3.3
239 + *
240 + * @param WP_Screen $screen Screen object.
241 + * @return bool True if the screen is a block editor, false otherwise.
242 + */
243 + protected function is_block_editor( $screen ) {
244 + return method_exists( $screen, 'is_block_editor' ) && $screen->is_block_editor() && ! pll_use_block_editor_plugin();
245 + }
246 +
247 + /**
205 248 * Enqueue scripts to the WP Customizer.
206 249 *
207 250 * @since 2.4.0
208 251 *
@@ -208,23 +251,32 @@
208 251 *
209 252 * @return void
210 253 */
211 254 public function customize_controls_enqueue_scripts() {
212 - if ( $this->model->get_languages_list() ) {
255 + if ( $this->model->has_languages() ) {
213 256 $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
214 257 wp_enqueue_script( 'pll_widgets', plugins_url( '/js/build/widgets' . $suffix . '.js', POLYLANG_ROOT_FILE ), array( 'jquery' ), POLYLANG_VERSION, true );
215 - $this->localize_scripts();
258 + $this->add_inline_scripts();
216 259 }
217 260 }
218 261
219 262 /**
220 - * Localize scripts.
263 + * Adds inline scripts to set the default language in JS
264 + * and localizes scripts.
221 265 *
222 - * @since 2.4.0
266 + * @since 3.3
223 267 *
224 268 * @return void
225 269 */
226 - public function localize_scripts() {
270 + private function add_inline_scripts() {
271 + if ( wp_script_is( 'pll_block-editor', 'enqueued' ) ) {
272 + $default_lang_script = 'const pllDefaultLanguage = "' . $this->options['default_lang'] . '";';
273 + wp_add_inline_script(
274 + 'pll_block-editor',
275 + $default_lang_script,
276 + 'before'
277 + );
278 + }
227 279 if ( wp_script_is( 'pll_widgets', 'enqueued' ) ) {
228 280 wp_localize_script(
229 281 'pll_widgets',
230 282 'pll_widgets',
@@ -235,24 +287,24 @@
235 287 }
236 288 }
237 289
238 290 /**
239 - * Sets pll_ajax_backend on all backend ajax request
240 - * The final goal is to detect if an ajax request is made on admin or frontend
291 + * Returns the data to use with the AJAX filter.
292 + * The final goal is to detect if an ajax request is made on admin or frontend.
241 293 *
242 294 * Takes care to various situations:
243 - * when the ajax request has no options.data thanks to ScreenfeedFr
244 - * see: https://wordpress.org/support/topic/ajaxprefilter-may-not-work-as-expected
245 - * when options.data is a json string
246 - * see: https://wordpress.org/support/topic/polylang-breaking-third-party-ajax-requests-on-admin-panels
247 - * when options.data is an empty string (GET request with the method 'load')
248 - * see: https://wordpress.org/support/topic/invalid-url-during-wordpress-new-dashboard-widget-operation
295 + * - When the AJAX request has no `options.data` thanks to ScreenfeedFr.
296 + * See: https://wordpress.org/support/topic/ajaxprefilter-may-not-work-as-expected.
297 + * - When `options.data` is a JSON string.
298 + * See: https://wordpress.org/support/topic/polylang-breaking-third-party-ajax-requests-on-admin-panels.
299 + * - When `options.data` is an empty string (GET request with the method 'load').
300 + * See: https://wordpress.org/support/topic/invalid-url-during-wordpress-new-dashboard-widget-operation.
249 301 *
250 - * @since 1.4
302 + * @since 3.7
251 303 *
252 - * @return void
304 + * @return array
253 305 */
254 - public function admin_print_footer_scripts() {
306 + public function get_ajax_filter_data(): array {
255 307 global $post_ID, $tag_ID;
256 308
257 309 $params = array( 'pll_ajax_backend' => 1 );
258 310 if ( ! empty( $post_ID ) ) {
@@ -262,65 +314,16 @@
262 314 if ( ! empty( $tag_ID ) ) {
263 315 $params = array_merge( $params, array( 'pll_term_id' => (int) $tag_ID ) );
264 316 }
265 317
266 - $str = http_build_query( $params );
267 - $arr = wp_json_encode( $params );
268 - ?>
269 - <script type="text/javascript">
270 - if (typeof jQuery != 'undefined') {
271 - jQuery(
272 - function( $ ){
273 - $.ajaxPrefilter( function ( options, originalOptions, jqXHR ) {
274 - if ( -1 != options.url.indexOf( ajaxurl ) || -1 != ajaxurl.indexOf( options.url ) ) {
275 -
276 - function addPolylangParametersAsString() {
277 - if ( 'undefined' === typeof options.data || '' === options.data.trim() ) {
278 - // Only Polylang data need to be send. So it could be as a simple query string.
279 - options.data = '<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>';
280 - } else {
281 - /*
282 - * In some cases data could be a JSON string like in third party plugins.
283 - * So we need not to break their process by adding polylang parameters as valid JSON datas.
284 - */
285 - try {
286 - options.data = JSON.stringify( Object.assign( JSON.parse( options.data ), <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> ) );
287 - } catch( exception ) {
288 - // Add Polylang data to the existing query string.
289 - options.data = options.data + '&<?php echo $str; // phpcs:ignore WordPress.Security.EscapeOutput ?>';
290 - }
291 - }
292 - }
293 -
294 - /*
295 - * options.processData set to true is the default jQuery process where the data is converted in a query string by using jQuery.param().
296 - * This step is done before applying filters. Thus here the options.data is already a string in this case.
297 - * @See https://github.com/jquery/jquery/blob/3.5.1/src/ajax.js#L563-L569 jQuery ajax function.
298 - * It is the most case WordPress send ajax request this way however third party plugins or themes could be send JSON string.
299 - * Use JSON format is recommended in jQuery.param() documentation to be able to send complex data structures.
300 - * @See https://api.jquery.com/jquery.param/ jQuery param function.
301 - */
302 - if ( options.processData ) {
303 - addPolylangParametersAsString();
304 - } else {
305 - /*
306 - * If options.processData is set to false data could be undefined or pass as a string.
307 - * So data as to be processed as if options.processData is set to true.
308 - */
309 - if ( 'undefined' === typeof options.data || 'string' === typeof options.data ) {
310 - addPolylangParametersAsString();
311 - } else {
312 - // Otherwise options.data is probably an object.
313 - options.data = Object.assign( options.data, <?php echo $arr; // phpcs:ignore WordPress.Security.EscapeOutput ?> );
314 - }
315 - }
316 - }
317 - });
318 - }
319 - );
320 - }
321 - </script>
322 - <?php
318 + /**
319 + * Filters the list of parameters to add to the admin ajax request.
320 + *
321 + * @since 3.4.5
322 + *
323 + * @param array $params List of parameters to add to the admin ajax request.
324 + */
325 + return (array) apply_filters( 'pll_admin_ajax_params', $params );
323 326 }
324 327
325 328 /**
326 329 * Sets the admin current language, used to filter the content
@@ -358,10 +361,20 @@
358 361 if ( wp_doing_ajax() && ! empty( $_REQUEST['lang'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
359 362 $this->curlang = $this->model->get_language( sanitize_key( $_REQUEST['lang'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
360 363 }
361 364
365 + /**
366 + * Filters the current language used by Polylang in the admin context.
367 + *
368 + * @since 3.2
369 + *
370 + * @param PLL_Language|false|null $curlang Instance of the current language.
371 + * @param PLL_Admin_Base $polylang Instance of the main Polylang's object.
372 + */
373 + $this->curlang = apply_filters( 'pll_admin_current_language', $this->curlang, $this );
374 +
362 375 // Inform that the admin language has been set.
363 - if ( $this->curlang ) {
376 + if ( $this->curlang instanceof PLL_Language ) {
364 377 /** This action is documented in frontend/choose-lang.php */
365 378 do_action( 'pll_language_defined', $this->curlang->slug, $this->curlang );
366 379 } else {
367 380 /** This action is documented in include/class-polylang.php */
@@ -386,9 +399,9 @@
386 399
387 400 $this->filter_lang = $this->model->get_language( get_user_meta( get_current_user_id(), 'pll_filter_content', true ) );
388 401
389 402 // Set preferred language for use when saving posts and terms: must not be empty
390 - $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_language( $this->options['default_lang'] ) : $this->filter_lang;
403 + $this->pref_lang = empty( $this->filter_lang ) ? $this->model->get_default_language() : $this->filter_lang;
391 404
392 405 /**
393 406 * Filters the preferred language on admin side.
394 407 * The preferred language is used for example to determine the language of a new post.
@@ -399,11 +412,8 @@
399 412 */
400 413 $this->pref_lang = apply_filters( 'pll_admin_preferred_language', $this->pref_lang );
401 414
402 415 $this->set_current_language();
403 -
404 - // Plugin i18n, only needed for backend.
405 - load_plugin_textdomain( 'polylang' );
406 416 }
407 417
408 418 /**
409 419 * Avoids parsing a tax query when all languages are requested
@@ -412,9 +422,9 @@
412 422 * @see https://core.trac.wordpress.org/ticket/31246 the suggestion of @boonebgorges.
413 423 *
414 424 * @since 1.6.5
415 425 *
416 - * @param array $qvars
426 + * @param array $qvars The array of requested query variables.
417 427 * @return array
418 428 */
419 429 public function request( $qvars ) {
420 430 if ( isset( $qvars['lang'] ) && 'all' === $qvars['lang'] ) {
@@ -442,9 +452,9 @@
442 452 $selected = empty( $this->filter_lang ) ? $all_item : $this->filter_lang;
443 453
444 454 $title = sprintf(
445 455 '<span class="ab-label"%1$s><span class="screen-reader-text">%2$s</span>%3$s</span>',
446 - 'all' === $selected->slug ? '' : sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ),
456 + $selected instanceof PLL_Language ? sprintf( ' lang="%s"', esc_attr( $selected->get_locale( 'display' ) ) ) : '',
447 457 __( 'Filters content by language', 'polylang' ),
448 458 esc_html( $selected->name )
449 459 );
450 460
@@ -456,17 +466,23 @@
456 466 * @param array $items The admin languages filter submenu items.
457 467 */
458 468 $items = apply_filters( 'pll_admin_languages_filter', array_merge( array( $all_item ), $this->model->get_languages_list() ) );
459 469
470 + $menu = array(
471 + 'id' => 'languages',
472 + 'title' => $selected->flag . $title,
473 + 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ),
474 + 'meta' => array(
475 + 'title' => __( 'Filters content by language', 'polylang' ),
476 + ),
477 + );
478 +
479 + if ( 'all' !== $selected->slug ) {
480 + $menu['meta']['class'] = 'pll-filtered-languages';
481 + }
482 +
460 483 if ( ! empty( $items ) ) {
461 - $wp_admin_bar->add_menu(
462 - array(
463 - 'id' => 'languages',
464 - 'title' => $selected->flag . $title,
465 - 'href' => esc_url( add_query_arg( 'lang', $selected->slug, remove_query_arg( 'paged' ) ) ),
466 - 'meta' => array( 'title' => __( 'Filters content by language', 'polylang' ) ),
467 - )
468 - );
484 + $wp_admin_bar->add_menu( $menu );
469 485 }
470 486
471 487 foreach ( $items as $lang ) {
472 488 if ( $selected->slug === $lang->slug ) {
@@ -481,7 +497,34 @@
481 497 'href' => esc_url( add_query_arg( 'lang', $lang->slug, remove_query_arg( 'paged' ) ) ),
482 498 'meta' => 'all' === $lang->slug ? array() : array( 'lang' => esc_attr( $lang->get_locale( 'display' ) ) ),
483 499 )
484 500 );
501 + }
502 + }
503 +
504 + /**
505 + * Remove the customize submenu when using a block theme.
506 + *
507 + * WordPress removes the Customizer menu if a block theme is activated and no other plugins interact with it.
508 + * As Polylang interacts with the Customizer, we have to delete this menu ourselves in the case of a block theme,
509 + * unless another plugin than Polylang interacts with the Customizer.
510 + *
511 + * @since 3.2
512 + *
513 + * @return void
514 + */
515 + public function remove_customize_submenu() {
516 + if ( ! $this->should_customize_menu_be_removed() ) {
517 + return;
518 + }
519 +
520 + global $submenu;
521 +
522 + if ( ! empty( $submenu['themes.php'] ) ) {
523 + foreach ( $submenu['themes.php'] as $submenu_item ) {
524 + if ( 'customize' === $submenu_item[1] ) {
525 + remove_submenu_page( 'themes.php', $submenu_item[2] );
526 + }
527 + }
485 528 }
486 529 }
487 530 }