PluginProbe
Polylang / 2.6.2
Polylang v2.6.2
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-model.php +93 -125 3.0.22.6.2 View file →
@@ -1,11 +1,8 @@
1 1 <?php
2 -/**
3 - * @package Polylang
4 - */
5 2
6 3 /**
7 - * Extends the PLL_Model class with methods needed only in Polylang settings pages.
4 + * Extends the PLL_Model class with methods needed only in Polylang settings pages
8 5 *
9 6 * @since 1.2
10 7 */
11 8 class PLL_Admin_Model extends PLL_Model {
@@ -11,22 +8,25 @@
11 8 class PLL_Admin_Model extends PLL_Model {
12 9
13 10 /**
14 11 * Adds a new language
15 - * and creates a default category for this language.
12 + * Creates a default category for this language
16 13 *
14 + * List of arguments that $args must contain:
15 + * name -> language name ( used only for display )
16 + * slug -> language code ( ideally 2-letters ISO 639-1 language code )
17 + * locale -> WordPress locale. If something wrong is used for the locale, the .mo files will not be loaded...
18 + * rtl -> 1 if rtl language, 0 otherwise
19 + * term_group -> language order when displayed
20 + *
21 + * Optional arguments that $args can contain:
22 + * no_default_cat -> if set, no default category will be created for this language
23 + * flag -> country code, see flags.php
24 + *
17 25 * @since 1.2
18 26 *
19 - * @param array $args {
20 - * @type string $name Language name ( used only for display ).
21 - * @type string $slug Language code ( ideally 2-letters ISO 639-1 language code ).
22 - * @type string $locale WordPress locale. If something wrong is used for the locale, the .mo files will not be loaded...
23 - * @type int $rtl 1 if rtl language, 0 otherwise.
24 - * @type int $term_group Language order when displayed.
25 - * @type string $no_default_cat Optional, if set, no default category will be created for this language.
26 - * @type string $flag Optional, country code, @see flags.php.
27 - * }
28 - * @return WP_Error|true true if success / WP_Error if failed.
27 + * @param array $args
28 + * @return bool true if success / false if failed
29 29 */
30 30 public function add_language( $args ) {
31 31 $errors = $this->validate_lang( $args );
32 32 if ( $errors->get_error_code() ) { // Using has_errors() would be more meaningful but is available only since WP 5.0
@@ -63,13 +63,13 @@
63 63 $mo = new PLL_MO();
64 64 $mo->export_to_db( $this->get_language( $args['slug'] ) );
65 65
66 66 /**
67 - * Fires when a language is added.
67 + * Fires when a language is added
68 68 *
69 69 * @since 1.9
70 70 *
71 - * @param array $args Arguments used to create the language. @see PLL_Admin_Model::add_language().
71 + * @param array $args arguments used to create the language
72 72 */
73 73 do_action( 'pll_add_language', $args );
74 74
75 75 $this->clean_languages_cache(); // Again to set add mo_id in the cached languages list
@@ -77,14 +77,13 @@
77 77 return true;
78 78 }
79 79
80 80 /**
81 - * Delete a language.
81 + * Delete a language
82 82 *
83 83 * @since 1.2
84 84 *
85 - * @param int $lang_id Language term_id.
86 - * @return bool
85 + * @param int $lang_id language term_id
87 86 */
88 87 public function delete_language( $lang_id ) {
89 88 $lang = $this->get_language( (int) $lang_id );
90 89
@@ -125,9 +124,9 @@
125 124
126 125 // Delete menus locations
127 126 if ( ! empty( $this->options['nav_menus'] ) ) {
128 127 foreach ( $this->options['nav_menus'] as $theme => $locations ) {
129 - foreach ( array_keys( $locations ) as $location ) {
128 + foreach ( $locations as $location => $languages ) {
130 129 unset( $this->options['nav_menus'][ $theme ][ $location ][ $lang->slug ] );
131 130 }
132 131 }
133 132 }
@@ -139,9 +138,9 @@
139 138 }
140 139
141 140 // Delete the string translations
142 141 $post = wpcom_vip_get_page_by_title( 'polylang_mo_' . $lang->term_id, OBJECT, 'polylang_mo' );
143 - if ( $post instanceof WP_Post ) {
142 + if ( ! empty( $post ) ) {
144 143 wp_delete_post( $post->ID );
145 144 }
146 145
147 146 // Delete domain
@@ -159,22 +158,25 @@
159 158 return true;
160 159 }
161 160
162 161 /**
163 - * Updates language properties.
162 + * Update language properties
164 163 *
164 + * List of arguments that $args must contain:
165 + * lang_id -> term_id of the language to modify
166 + * name -> language name ( used only for display )
167 + * slug -> language code ( ideally 2-letters ISO 639-1 language code
168 + * locale -> WordPress locale. If something wrong is used for the locale, the .mo files will not be loaded...
169 + * rtl -> 1 if rtl language, 0 otherwise
170 + * term_group -> language order when displayed
171 + *
172 + * Optional arguments that $args can contain:
173 + * flag -> country code, see flags.php
174 + *
165 175 * @since 1.2
166 176 *
167 - * @param array $args {
168 - * @type int $lang_id Id of the language to modify.
169 - * @type string $name Language name ( used only for display ).
170 - * @type string $slug Language code ( ideally 2-letters ISO 639-1 language code ).
171 - * @type string $locale WordPress locale. If something wrong is used for the locale, the .mo files will not be loaded...
172 - * @type int $rtl 1 if rtl language, 0 otherwise.
173 - * @type int $term_group Language order when displayed.
174 - * @type string $flag Optional, country code, @see flags.php.
175 - * }
176 - * @return WP_Error|true true if success / WP_Error if failed.
177 + * @param array $args
178 + * @return bool true if success / false if failed
177 179 */
178 180 public function update_language( $args ) {
179 181 $lang = $this->get_language( (int) $args['lang_id'] );
180 182
@@ -208,9 +210,9 @@
208 210
209 211 // Update menus locations
210 212 if ( ! empty( $this->options['nav_menus'] ) ) {
211 213 foreach ( $this->options['nav_menus'] as $theme => $locations ) {
212 - foreach ( array_keys( $locations ) as $location ) {
214 + foreach ( $locations as $location => $languages ) {
213 215 if ( ! empty( $this->options['nav_menus'][ $theme ][ $location ][ $old_slug ] ) ) {
214 216 $this->options['nav_menus'][ $theme ][ $location ][ $slug ] = $this->options['nav_menus'][ $theme ][ $location ][ $old_slug ];
215 217 unset( $this->options['nav_menus'][ $theme ][ $location ][ $old_slug ] );
216 218 }
@@ -237,13 +239,13 @@
237 239 wp_update_term( (int) $lang->term_id, 'language', array( 'slug' => $slug, 'name' => $args['name'], 'description' => $description, 'term_group' => (int) $args['term_group'] ) );
238 240 wp_update_term( (int) $lang->tl_term_id, 'term_language', array( 'slug' => 'pll_' . $slug, 'name' => $args['name'] ) );
239 241
240 242 /**
241 - * Fires when a language is updated.
243 + * Fires when a language is added
242 244 *
243 245 * @since 1.9
244 246 *
245 - * @param array $args Arguments used to modify the language. @see PLL_Admin_Model::update_language().
247 + * @param array $args arguments used to modify the language
246 248 */
247 249 do_action( 'pll_update_language', $args );
248 250
249 251 $this->clean_languages_cache();
@@ -251,17 +253,17 @@
251 253 return true;
252 254 }
253 255
254 256 /**
255 - * Validates data entered when creating or updating a language.
257 + * Validates data entered when creating or updating a language
256 258 *
257 - * @see PLL_Admin_Model::add_language().
259 + * @see PLL_Admin_Model::add_language
258 260 *
259 261 * @since 0.4
260 262 *
261 - * @param array $args Parameters of {@see PLL_Admin_Model::add_language() or @see PLL_Admin_Model::update_language()}.
262 - * @param PLL_Language $lang Optional the language currently updated, the language is created if not set.
263 - * @return WP_Error
263 + * @param array $args
264 + * @param object $lang optional the language currently updated, the language is created if not set
265 + * @return bool true if success / false if failed
264 266 */
265 267 protected function validate_lang( $args, $lang = null ) {
266 268 $errors = new WP_Error();
267 269
@@ -276,9 +278,9 @@
276 278 }
277 279
278 280 // Validate slug is unique
279 281 foreach ( $this->get_languages_list() as $language ) {
280 - if ( $language->slug === $args['slug'] && ( null === $lang || $lang->term_id !== $language->term_id ) ) {
282 + if ( $language->slug === $args['slug'] && ( null === $lang || ( isset( $lang ) && $lang->term_id != $language->term_id ) ) ) {
281 283 $errors->add( 'pll_non_unique_slug', __( 'The language code must be unique', 'polylang' ) );
282 284 }
283 285 }
284 286
@@ -304,30 +306,23 @@
304 306 return $errors;
305 307 }
306 308
307 309 /**
308 - * Assigns a language to posts or terms in mass.
310 + * Used to set the language of posts or terms in mass
309 311 *
310 312 * @since 1.2
311 313 *
312 - * @param string $type Either 'post' or 'term'.
313 - * @param int[] $ids Array of post ids or term ids.
314 - * @param PLL_Language|string $lang Language to assign to the posts or terms.
315 - * @return void
314 + * @param string $type either 'post' or 'term'
315 + * @param array $ids array of post ids or term ids
316 + * @param object|string $lang object or slug
316 317 */
317 318 public function set_language_in_mass( $type, $ids, $lang ) {
318 319 global $wpdb;
319 320
321 + $ids = array_map( 'intval', $ids );
320 322 $lang = $this->get_language( $lang );
323 + $tt_id = 'term' === $type ? $lang->tl_term_taxonomy_id : $lang->term_taxonomy_id;
321 324
322 - if ( empty( $lang ) ) {
323 - return;
324 - }
325 -
326 - $tt_id = 'term' === $type ? $lang->tl_term_taxonomy_id : $lang->term_taxonomy_id;
327 - $values = array();
328 - $ids = array_map( 'intval', $ids );
329 -
330 325 foreach ( $ids as $id ) {
331 326 $values[] = $wpdb->prepare( '( %d, %d )', $id, $tt_id );
332 327 }
333 328
@@ -338,9 +333,8 @@
338 333 }
339 334
340 335 if ( 'term' === $type ) {
341 336 clean_term_cache( $ids, 'term_language' );
342 - $translations = array();
343 337
344 338 foreach ( $ids as $id ) {
345 339 $translations[] = array( $lang->slug => $id );
346 340 }
@@ -353,24 +347,19 @@
353 347 }
354 348 }
355 349
356 350 /**
357 - * Creates translations groups in mass.
351 + * Used to create a translations groups in mass
358 352 *
359 353 * @since 1.6.3
360 354 *
361 - * @param string $type Either 'post' or 'term'
362 - * @param array $translations Array of translations arrays.
363 - * @return void
355 + * @param string $type either 'post' or 'term'
356 + * @param array $translations array of translations arrays
364 357 */
365 358 public function set_translation_in_mass( $type, $translations ) {
366 359 global $wpdb;
367 360
368 - $taxonomy = $type . '_translations';
369 - $terms = array();
370 - $slugs = array();
371 - $description = array();
372 - $count = array();
361 + $taxonomy = $type . '_translations';
373 362
374 363 foreach ( $translations as $t ) {
375 364 $term = uniqid( 'pll_' ); // the term name
376 365 $terms[] = $wpdb->prepare( '( %s, %s )', $term, $term );
@@ -386,11 +375,9 @@
386 375 }
387 376
388 377 // Get all terms with their term_id
389 378 // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
390 - $terms = $wpdb->get_results( "SELECT term_id, slug FROM {$wpdb->terms} WHERE slug IN ( " . implode( ',', $slugs ) . ' )' );
391 - $term_ids = array();
392 - $tts = array();
379 + $terms = $wpdb->get_results( "SELECT term_id, slug FROM {$wpdb->terms} WHERE slug IN ( " . implode( ',', $slugs ) . ' )' );
393 380
394 381 // Prepare terms taxonomy relationship
395 382 foreach ( $terms as $term ) {
396 383 $term_ids[] = $term->term_id;
@@ -404,19 +391,16 @@
404 391 }
405 392
406 393 // Get all terms with term_taxonomy_id
407 394 $terms = get_terms( $taxonomy, array( 'hide_empty' => false ) );
408 - $trs = array();
409 395
410 - // Prepare objects relationships.
411 - if ( is_array( $terms ) ) {
412 - foreach ( $terms as $term ) {
413 - $t = maybe_unserialize( $term->description );
414 - if ( in_array( $t, $translations ) ) {
415 - foreach ( $t as $object_id ) {
416 - if ( ! empty( $object_id ) ) {
417 - $trs[] = $wpdb->prepare( '( %d, %d )', $object_id, $term->term_taxonomy_id );
418 - }
396 + // Prepare objects relationships
397 + foreach ( $terms as $term ) {
398 + $t = maybe_unserialize( $term->description );
399 + if ( in_array( $t, $translations ) ) {
400 + foreach ( $t as $object_id ) {
401 + if ( ! empty( $object_id ) ) {
402 + $trs[] = $wpdb->prepare( '( %d, %d )', $object_id, $term->term_taxonomy_id );
419 403 }
420 404 }
421 405 }
422 406 }
@@ -431,32 +415,27 @@
431 415 clean_term_cache( $term_ids, $taxonomy );
432 416 }
433 417
434 418 /**
435 - * Returns untranslated posts and terms ids ( used in settings ).
419 + * Returns untranslated posts and terms ids ( used in settings )
436 420 *
437 421 * @since 0.9
438 - * @since 2.2.6 Add the $limit argument.
422 + * @since 2.2.6 Add the $limit argument
439 423 *
440 - * @param int $limit Max number of posts or terms to return. Defaults to -1 (no limit).
441 - * @return array {
442 - * Objects without language.
443 - *
444 - * @type int[] $posts Array of post ids.
445 - * @type int[] $terms Array of term ids.
446 - * }
424 + * @param in $limit Max number of posts or terms to return. Defaults to -1 (no limit).
425 + * @return array Array made of an array of post ids and an array of term ids
447 426 */
448 427 public function get_objects_with_no_lang( $limit = -1 ) {
449 428 global $wpdb;
450 429
451 430 /**
452 - * Filters the max number of posts or terms to return when searching objects with no language.
431 + * Filters the max number of posts or terms to return when searching objects with no language
453 432 * This filter can be used to decrease the memory usage in case the number of objects
454 433 * without language is too big. Using a negative value is equivalent to have no limit.
455 434 *
456 435 * @since 2.2.6
457 436 *
458 - * @param int $limit Max number of posts or terms to retrieve from the database.
437 + * @param int $limit Max number of posts or terms to retrieve from the database
459 438 */
460 439 $limit = (int) apply_filters( 'get_objects_with_no_lang_limit', $limit );
461 440
462 441 $posts = get_posts(
@@ -492,56 +471,48 @@
492 471 );
493 472 // PHPCS:enable
494 473
495 474 /**
496 - * Filters the list of untranslated posts ids and terms ids
475 + * Filter the list of untranslated posts ids and terms ids
497 476 *
498 477 * @since 0.9
499 478 *
500 - * @param array|false $objects false if no ids found, list of post and/or term ids otherwise.
479 + * @param bool|array $objects false if no ids found, list of post and/or term ids otherwise
501 480 */
502 481 return apply_filters( 'pll_get_objects_with_no_lang', empty( $posts ) && empty( $terms ) ? false : array( 'posts' => $posts, 'terms' => $terms ) );
503 482 }
504 483
505 484 /**
506 - * Updates the translations when a language slug has been modified in settings
507 - * or deletes them when a language is removed.
485 + * Used to delete translations or update the translations when a language slug has been modified in settings
508 486 *
509 487 * @since 0.5
510 488 *
511 - * @param string $old_slug The old language slug.
512 - * @param string $new_slug Optional, the new language slug, if not set it means that the language has been deleted.
513 - * @return void
489 + * @param string $old_slug the old language slug
490 + * @param string $new_slug optional, the new language slug, if not set it means the correspondent has been deleted
514 491 */
515 492 public function update_translations( $old_slug, $new_slug = '' ) {
516 493 global $wpdb;
517 494
518 - $terms = get_terms( array( 'post_translations', 'term_translations' ) );
519 - $term_ids = array();
520 - $dr = array();
521 - $dt = array();
522 - $ut = array();
495 + $terms = get_terms( array( 'post_translations', 'term_translations' ) );
523 496
524 - if ( is_array( $terms ) ) {
525 - foreach ( $terms as $term ) {
526 - $term_ids[ $term->taxonomy ][] = $term->term_id;
527 - $tr = maybe_unserialize( $term->description );
528 - if ( ! empty( $tr[ $old_slug ] ) ) {
529 - if ( $new_slug ) {
530 - $tr[ $new_slug ] = $tr[ $old_slug ]; // Suppress this for delete
531 - } else {
532 - $dr['id'][] = (int) $tr[ $old_slug ];
533 - $dr['tt'][] = (int) $term->term_taxonomy_id;
534 - }
535 - unset( $tr[ $old_slug ] );
497 + foreach ( $terms as $term ) {
498 + $term_ids[ $term->taxonomy ][] = $term->term_id;
499 + $tr = maybe_unserialize( $term->description );
500 + if ( ! empty( $tr[ $old_slug ] ) ) {
501 + if ( $new_slug ) {
502 + $tr[ $new_slug ] = $tr[ $old_slug ]; // Suppress this for delete
503 + } else {
504 + $dr['id'][] = (int) $tr[ $old_slug ];
505 + $dr['tt'][] = (int) $term->term_taxonomy_id;
506 + }
507 + unset( $tr[ $old_slug ] );
536 508
537 - if ( empty( $tr ) || 1 == count( $tr ) ) {
538 - $dt['t'][] = (int) $term->term_id;
539 - $dt['tt'][] = (int) $term->term_taxonomy_id;
540 - } else {
541 - $ut['case'][] = $wpdb->prepare( 'WHEN %d THEN %s', $term->term_id, maybe_serialize( $tr ) );
542 - $ut['in'][] = (int) $term->term_id;
543 - }
509 + if ( empty( $tr ) || 1 == count( $tr ) ) {
510 + $dt['t'][] = (int) $term->term_id;
511 + $dt['tt'][] = (int) $term->term_taxonomy_id;
512 + } else {
513 + $ut['case'][] = $wpdb->prepare( 'WHEN %d THEN %s', $term->term_id, maybe_serialize( $tr ) );
514 + $ut['in'][] = (int) $term->term_id;
544 515 }
545 516 }
546 517 }
547 518
@@ -581,21 +552,18 @@
581 552 }
582 553
583 554 /**
584 555 * Updates the default language
585 - * taking care to update the default category & the nav menu locations.
556 + * taking care to update the default category & the nav menu locations
586 557 *
587 558 * @since 1.8
588 559 *
589 - * @param string $slug New language slug.
590 - * @return void
560 + * @param string $slug new language slug
591 561 */
592 562 public function update_default_lang( $slug ) {
593 563 // The nav menus stored in theme locations should be in the default language
594 564 $theme = get_stylesheet();
595 565 if ( ! empty( $this->options['nav_menus'][ $theme ] ) ) {
596 - $menus = array();
597 -
598 566 foreach ( $this->options['nav_menus'][ $theme ] as $key => $loc ) {
599 567 $menus[ $key ] = empty( $loc[ $slug ] ) ? 0 : $loc[ $slug ];
600 568 }
601 569 set_theme_mod( 'nav_menu_locations', $menus );