PluginProbe
Polylang / 3.2.4
Polylang v3.2.4
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
polylang / include / model.php

model.php in Polylang 3.2.4, at include/model.php

757 lines 25.4 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * @package Polylang
4 */
5
6 /**
7 * Setups the language and translations model based on WordPress taxonomies
8 *
9 * @since 1.2
10 */
11 class PLL_Model {
12 /**
13 * Internal non persistent cache object.
14 *
15 * @var PLL_Cache
16 */
17 public $cache;
18
19 /**
20 * Stores the plugin options.
21 *
22 * @var array
23 */
24 public $options;
25
26 /**
27 * Translated post model.
28 *
29 * @var PLL_Translated_Post
30 */
31 public $post;
32
33 /**
34 * Translated term model.
35 *
36 * @var PLL_Translated_Term
37 */
38 public $term;
39
40 /**
41 * Constructor.
42 * Setups translated objects sub models.
43 * Setups filters and actions.
44 *
45 * @since 1.2
46 *
47 * @param array $options Polylang options.
48 */
49 public function __construct( &$options ) {
50 $this->options = &$options;
51
52 $this->cache = new PLL_Cache();
53 $this->post = new PLL_Translated_Post( $this ); // Translated post sub model.
54 $this->term = new PLL_Translated_Term( $this ); // Translated term sub model.
55
56 // We need to clean languages cache when editing a language and when modifying the permalink structure.
57 add_action( 'edited_term_taxonomy', array( $this, 'clean_languages_cache' ), 10, 2 );
58 add_action( 'update_option_permalink_structure', array( $this, 'clean_languages_cache' ) );
59 add_action( 'update_option_siteurl', array( $this, 'clean_languages_cache' ) );
60 add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) );
61
62 add_filter( 'get_terms_args', array( $this, 'get_terms_args' ) );
63
64 // Just in case someone would like to display the language description ;).
65 add_filter( 'language_description', '__return_empty_string' );
66 }
67
68 /**
69 * Returns the list of available languages.
70 * - Stores the list in a db transient ( except flags ), unless PLL_CACHE_LANGUAGES is set to false.
71 * - Caches the list ( with flags ) in a PLL_Cache object.
72 *
73 * @since 0.1
74 *
75 * @param array $args {
76 * @type bool $hide_empty Hides languages with no posts if set to true ( defaults to false ).
77 * @type string $fields Returns only that field if set; {@see PLL_Language} for a list of fields.
78 * }
79 * @return array List of PLL_Language objects or PLL_Language object properties.
80 */
81 public function get_languages_list( $args = array() ) {
82 if ( false === $languages = $this->cache->get( 'languages' ) ) {
83 $languages = array();
84
85 // Create the languages from taxonomies.
86 if ( ( defined( 'PLL_CACHE_LANGUAGES' ) && ! PLL_CACHE_LANGUAGES ) || false === ( $languages = get_transient( 'pll_languages_list' ) ) ) {
87 $languages = array();
88
89 $post_languages = $this->get_language_terms();
90
91 $term_languages = get_terms( 'term_language', array( 'hide_empty' => false ) );
92 $term_languages = empty( $term_languages ) || is_wp_error( $term_languages ) ?
93 array() : array_combine( wp_list_pluck( $term_languages, 'slug' ), $term_languages );
94
95 if ( ! empty( $post_languages ) && ! empty( $term_languages ) ) {
96 foreach ( $post_languages as $k => $v ) {
97 if ( isset( $term_languages[ 'pll_' . $v->slug ] ) ) {
98 $languages[ $k ] = new PLL_Language( $v, $term_languages[ 'pll_' . $v->slug ] );
99 }
100 }
101
102 // We will need the languages list to allow its access in the filter below.
103 $this->cache->set( 'languages', $languages );
104
105 /**
106 * Filters the list of languages *before* it is stored in the persistent cache.
107 * /!\ This filter is fired *before* the $polylang object is available.
108 *
109 * @since 1.7.5
110 *
111 * @param PLL_Language[] $languages The list of language objects.
112 * @param PLL_Model $model PLL_Model object.
113 */
114 $languages = apply_filters( 'pll_languages_list', $languages, $this );
115
116 /*
117 * Don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache.
118 * Thanks to captin411 for catching this!
119 * @see https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255
120 */
121 set_transient( 'pll_languages_list', array_map( 'get_object_vars', $languages ) );
122 }
123 }
124
125 // Create the languages directly from arrays stored in transients.
126 else {
127 foreach ( $languages as $k => $v ) {
128 $languages[ $k ] = new PLL_Language( $v );
129 }
130 }
131
132 /**
133 * Filters the list of languages *after* it is stored in the persistent cache.
134 * /!\ This filter is fired *before* the $polylang object is available.
135 *
136 * @since 1.8
137 *
138 * @param PLL_Language[] $languages The list of language objects.
139 */
140 $languages = apply_filters( 'pll_after_languages_cache', $languages );
141 $this->cache->set( 'languages', $languages );
142 }
143
144 $args = wp_parse_args( $args, array( 'hide_empty' => false ) );
145
146 // Remove empty languages if requested.
147 if ( $args['hide_empty'] ) {
148 $languages = wp_list_filter( $languages, array( 'count' => 0 ), 'NOT' );
149 }
150
151 return empty( $args['fields'] ) ? $languages : wp_list_pluck( $languages, $args['fields'] );
152 }
153
154 /**
155 * Cleans language cache
156 * can be called directly with no parameter
157 * called by the 'edited_term_taxonomy' filter with 2 parameters when count needs to be updated
158 *
159 * @since 1.2
160 *
161 * @param int $term not used
162 * @param string $taxonomy taxonomy name
163 * @return void
164 */
165 public function clean_languages_cache( $term = 0, $taxonomy = null ) {
166 if ( empty( $taxonomy ) || 'language' == $taxonomy ) {
167 delete_transient( 'pll_languages_list' );
168 $this->cache->clean();
169 }
170 }
171
172 /**
173 * Don't query term metas when only our taxonomies are queried
174 *
175 * @since 2.3
176 *
177 * @param array $args WP_Term_Query arguments
178 * @return array
179 */
180 public function get_terms_args( $args ) {
181 if ( isset( $args['taxonomy'] ) && ! array_diff( (array) $args['taxonomy'], array( 'language', 'term_language', 'post_translations', 'term_translations' ) ) ) {
182 $args['update_term_meta_cache'] = false;
183 }
184 return $args;
185 }
186
187 /**
188 * Returns the language by its term_id, tl_term_id, slug or locale.
189 *
190 * @since 0.1
191 *
192 * @param mixed $value term_id, tl_term_id, slug or locale of the queried language.
193 * @return PLL_Language|false Language object, false if no language found.
194 */
195 public function get_language( $value ) {
196 if ( is_object( $value ) ) {
197 return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // will force cast to PLL_Language
198 }
199
200 if ( false === $return = $this->cache->get( 'language:' . $value ) ) {
201 foreach ( $this->get_languages_list() as $lang ) {
202 $this->cache->set( 'language:' . $lang->term_id, $lang );
203 $this->cache->set( 'language:' . $lang->tl_term_id, $lang );
204 $this->cache->set( 'language:' . $lang->slug, $lang );
205 $this->cache->set( 'language:' . $lang->locale, $lang );
206 $this->cache->set( 'language:' . $lang->w3c, $lang );
207 }
208 $return = $this->cache->get( 'language:' . $value );
209 }
210
211 return $return;
212 }
213
214 /**
215 * Adds terms clauses to the term query to filter them by languages.
216 *
217 * @since 1.2
218 *
219 * @param string[] $clauses The list of sql clauses in terms query.
220 * @param PLL_Language $lang PLL_Language object.
221 * @return string[] Modified list of clauses.
222 */
223 public function terms_clauses( $clauses, $lang ) {
224 if ( ! empty( $lang ) && false === strpos( $clauses['join'], 'pll_tr' ) ) {
225 $clauses['join'] .= $this->term->join_clause();
226 $clauses['where'] .= $this->term->where_clause( $lang );
227 }
228 return $clauses;
229 }
230
231 /**
232 * Returns post types that need to be translated.
233 * The post types list is cached for better better performance.
234 * The method waits for 'after_setup_theme' to apply the cache
235 * to allow themes adding the filter in functions.php.
236 *
237 * @since 1.2
238 *
239 * @param bool $filter True if we should return only valid registered post types.
240 * @return string[] Post type names for which Polylang manages languages and translations.
241 */
242 public function get_translated_post_types( $filter = true ) {
243 if ( false === $post_types = $this->cache->get( 'post_types' ) ) {
244 $post_types = array( 'post' => 'post', 'page' => 'page', 'wp_block' => 'wp_block' );
245
246 if ( ! empty( $this->options['media_support'] ) ) {
247 $post_types['attachment'] = 'attachment';
248 }
249
250 if ( ! empty( $this->options['post_types'] ) && is_array( $this->options['post_types'] ) ) {
251 $post_types = array_merge( $post_types, array_combine( $this->options['post_types'], $this->options['post_types'] ) );
252 }
253
254 /**
255 * Filters the list of post types available for translation.
256 * The default are post types which have the parameter ‘public’ set to true.
257 * The filter must be added soon in the WordPress loading process:
258 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
259 *
260 * @since 0.8
261 *
262 * @param string[] $post_types List of post type names.
263 * @param bool $is_settings True when displaying the list of custom post types in Polylang settings.
264 */
265 $post_types = apply_filters( 'pll_get_post_types', $post_types, false );
266
267 if ( did_action( 'after_setup_theme' ) ) {
268 $this->cache->set( 'post_types', $post_types );
269 }
270 }
271
272 return $filter ? array_intersect( $post_types, get_post_types() ) : $post_types;
273 }
274
275 /**
276 * Returns true if Polylang manages languages and translations for this post type.
277 *
278 * @since 1.2
279 *
280 * @param string|string[] $post_type Post type name or array of post type names.
281 * @return bool
282 */
283 public function is_translated_post_type( $post_type ) {
284 $post_types = $this->get_translated_post_types( false );
285 return ( is_array( $post_type ) && array_intersect( $post_type, $post_types ) || in_array( $post_type, $post_types ) || 'any' === $post_type && ! empty( $post_types ) );
286 }
287
288 /**
289 * Returns taxonomies that need to be translated.
290 *
291 * @since 1.2
292 *
293 * @param bool $filter True if we should return only valid registered taxonomies.
294 * @return string[] Array of registered taxonomy names for which Polylang manages languages and translations.
295 */
296 public function get_translated_taxonomies( $filter = true ) {
297 if ( false === $taxonomies = $this->cache->get( 'taxonomies' ) ) {
298 $taxonomies = array( 'category' => 'category', 'post_tag' => 'post_tag' );
299
300 if ( ! empty( $this->options['taxonomies'] ) && is_array( $this->options['taxonomies'] ) ) {
301 $taxonomies = array_merge( $taxonomies, array_combine( $this->options['taxonomies'], $this->options['taxonomies'] ) );
302 }
303
304 /**
305 * Filters the list of taxonomies available for translation.
306 * The default are taxonomies which have the parameter ‘public’ set to true.
307 * The filter must be added soon in the WordPress loading process:
308 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
309 *
310 * @since 0.8
311 *
312 * @param string[] $taxonomies List of taxonomy names.
313 * @param bool $is_settings True when displaying the list of custom taxonomies in Polylang settings.
314 */
315 $taxonomies = apply_filters( 'pll_get_taxonomies', $taxonomies, false );
316 if ( did_action( 'after_setup_theme' ) ) {
317 $this->cache->set( 'taxonomies', $taxonomies );
318 }
319 }
320
321 return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies;
322 }
323
324 /**
325 * Returns true if Polylang manages languages and translations for this taxonomy.
326 *
327 * @since 1.2
328 *
329 * @param string|string[] $tax Taxonomy name or array of taxonomy names.
330 * @return bool
331 */
332 public function is_translated_taxonomy( $tax ) {
333 $taxonomies = $this->get_translated_taxonomies( false );
334 return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) );
335 }
336
337 /**
338 * Return staxonomies that need to be filtered ( post_format like ).
339 *
340 * @since 1.7
341 *
342 * @param bool $filter True if we should return only valid registered taxonomies.
343 * @return string[] Array of registered taxonomy names.
344 */
345 public function get_filtered_taxonomies( $filter = true ) {
346 if ( did_action( 'after_setup_theme' ) ) {
347 static $taxonomies = null;
348 }
349
350 if ( empty( $taxonomies ) ) {
351 $taxonomies = array( 'post_format' => 'post_format' );
352
353 /**
354 * Filters the list of taxonomies not translatable but filtered by language.
355 * Includes only the post format by default
356 * The filter must be added soon in the WordPress loading process:
357 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
358 *
359 * @since 1.7
360 *
361 * @param string[] $taxonomies List of taxonomy names.
362 * @param bool $is_settings True when displaying the list of custom taxonomies in Polylang settings.
363 */
364 $taxonomies = apply_filters( 'pll_filtered_taxonomies', $taxonomies, false );
365 }
366
367 return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies;
368 }
369
370 /**
371 * Returns true if Polylang filters this taxonomy per language.
372 *
373 * @since 1.7
374 *
375 * @param string|string[] $tax Taxonomy name or array of taxonomy names.
376 * @return bool
377 */
378 public function is_filtered_taxonomy( $tax ) {
379 $taxonomies = $this->get_filtered_taxonomies( false );
380 return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) );
381 }
382
383 /**
384 * Returns the query vars of all filtered taxonomies.
385 *
386 * @since 1.7
387 *
388 * @return array
389 */
390 public function get_filtered_taxonomies_query_vars() {
391 $query_vars = array();
392 foreach ( $this->get_filtered_taxonomies() as $filtered_tax ) {
393 $tax = get_taxonomy( $filtered_tax );
394 if ( ! empty( $tax ) ) {
395 $query_vars[] = $tax->query_var;
396 }
397 }
398 return $query_vars;
399 }
400
401 /**
402 * It is possible to have several terms with the same name in the same taxonomy ( one per language )
403 * but the native term_exists() will return true even if only one exists.
404 * So here the function adds the language parameter.
405 *
406 * @since 1.4
407 *
408 * @param string $term_name The term name.
409 * @param string $taxonomy Taxonomy name.
410 * @param int $parent Parent term id.
411 * @param string|PLL_Language $language The language slug or object.
412 * @return null|int The term_id of the found term.
413 */
414 public function term_exists( $term_name, $taxonomy, $parent, $language ) {
415 global $wpdb;
416
417 $term_name = trim( wp_unslash( $term_name ) );
418 $term_name = _wp_specialchars( $term_name );
419
420 $select = "SELECT t.term_id FROM $wpdb->terms AS t";
421 $join = " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id";
422 $join .= $this->term->join_clause();
423 $where = $wpdb->prepare( ' WHERE tt.taxonomy = %s AND t.name = %s', $taxonomy, $term_name );
424 $where .= $this->term->where_clause( $this->get_language( $language ) );
425
426 if ( $parent > 0 ) {
427 $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent );
428 }
429
430 // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
431 return $wpdb->get_var( $select . $join . $where );
432 }
433
434 /**
435 * Checks if a term slug exists in a given language, taxonomy, hierarchy.
436 *
437 * @since 1.9
438 * @since 2.8 Moved from PLL_Share_Term_Slug::term_exists() to PLL_Model::term_exists_by_slug().
439 *
440 * @param string $slug The term slug to test.
441 * @param string|PLL_Language $language The language slug or object.
442 * @param string $taxonomy Optional taxonomy name.
443 * @param int $parent Optional parent term id.
444 * @return null|int The term_id of the found term.
445 */
446 public function term_exists_by_slug( $slug, $language, $taxonomy = '', $parent = 0 ) {
447 global $wpdb;
448
449 $select = "SELECT t.term_id FROM {$wpdb->terms} AS t";
450 $join = " INNER JOIN {$wpdb->term_taxonomy} AS tt ON t.term_id = tt.term_id";
451 $join .= $this->term->join_clause();
452 $where = $wpdb->prepare( ' WHERE t.slug = %s', $slug );
453 $where .= $this->term->where_clause( $this->get_language( $language ) );
454
455 if ( ! empty( $taxonomy ) ) {
456 $where .= $wpdb->prepare( ' AND tt.taxonomy = %s', $taxonomy );
457 }
458
459 if ( $parent > 0 ) {
460 $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent );
461 }
462
463 // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
464 return $wpdb->get_var( $select . $join . $where );
465 }
466
467
468 /**
469 * Gets the number of posts per language in a date, author or post type archive.
470 *
471 * @since 1.2
472 *
473 * @param PLL_Language $lang PLL_Language instance.
474 * @param array $q {
475 * WP_Query arguments:
476 *
477 * @type string|string[] $post_type Post type or array of post types.
478 * @type int $m Combination YearMonth. Accepts any four-digit year and month.
479 * @type int $year Four-digit year.
480 * @type int $monthnum Two-digit month.
481 * @type int $day Day of the month.
482 * @type int $author Author id.
483 * @type string $author_name User 'user_nicename'.
484 * @type string $post_format Post format.
485 * @type string $post_status Post status.
486 * }
487 * @return int
488 */
489 public function count_posts( $lang, $q = array() ) {
490 global $wpdb;
491
492 $q = wp_parse_args( $q, array( 'post_type' => 'post', 'post_status' => 'publish' ) );
493
494 if ( ! is_array( $q['post_type'] ) ) {
495 $q['post_type'] = array( $q['post_type'] );
496 }
497
498 foreach ( $q['post_type'] as $key => $type ) {
499 if ( ! post_type_exists( $type ) ) {
500 unset( $q['post_type'][ $key ] );
501 }
502 }
503
504 if ( empty( $q['post_type'] ) ) {
505 $q['post_type'] = array( 'post' ); // We *need* a post type.
506 }
507
508 $cache_key = 'pll_count_posts_' . md5( maybe_serialize( $q ) );
509 $counts = wp_cache_get( $cache_key, 'counts' );
510
511 if ( false === $counts ) {
512 $counts = array();
513
514 $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts}";
515 $join = $this->post->join_clause();
516 $where = sprintf( " WHERE post_status = '%s'", esc_sql( $q['post_status'] ) );
517 $where .= sprintf( " AND {$wpdb->posts}.post_type IN ( '%s' )", implode( "', '", esc_sql( $q['post_type'] ) ) );
518 $where .= $this->post->where_clause( $this->get_languages_list() );
519 $groupby = ' GROUP BY pll_tr.term_taxonomy_id';
520
521 if ( ! empty( $q['m'] ) ) {
522 $q['m'] = '' . preg_replace( '|[^0-9]|', '', $q['m'] );
523 $where .= $wpdb->prepare( " AND YEAR( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 0, 4 ) );
524 if ( strlen( $q['m'] ) > 5 ) {
525 $where .= $wpdb->prepare( " AND MONTH( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 4, 2 ) );
526 }
527 if ( strlen( $q['m'] ) > 7 ) {
528 $where .= $wpdb->prepare( " AND DAYOFMONTH( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 6, 2 ) );
529 }
530 }
531
532 if ( ! empty( $q['year'] ) ) {
533 $where .= $wpdb->prepare( " AND YEAR( {$wpdb->posts}.post_date ) = %d", $q['year'] );
534 }
535
536 if ( ! empty( $q['monthnum'] ) ) {
537 $where .= $wpdb->prepare( " AND MONTH( {$wpdb->posts}.post_date ) = %d", $q['monthnum'] );
538 }
539
540 if ( ! empty( $q['day'] ) ) {
541 $where .= $wpdb->prepare( " AND DAYOFMONTH( {$wpdb->posts}.post_date ) = %d", $q['day'] );
542 }
543
544 if ( ! empty( $q['author_name'] ) ) {
545 $author = get_user_by( 'slug', sanitize_title_for_query( $q['author_name'] ) );
546 if ( $author ) {
547 $q['author'] = $author->ID;
548 }
549 }
550
551 if ( ! empty( $q['author'] ) ) {
552 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $q['author'] );
553 }
554
555 // Filtered taxonomies ( post_format ).
556 foreach ( $this->get_filtered_taxonomies_query_vars() as $tax_qv ) {
557
558 if ( ! empty( $q[ $tax_qv ] ) ) {
559 $join .= " INNER JOIN {$wpdb->term_relationships} AS tr ON tr.object_id = {$wpdb->posts}.ID";
560 $join .= " INNER JOIN {$wpdb->term_taxonomy} AS tt ON tt.term_taxonomy_id = tr.term_taxonomy_id";
561 $join .= " INNER JOIN {$wpdb->terms} AS t ON t.term_id = tt.term_id";
562 $where .= $wpdb->prepare( ' AND t.slug = %s', $q[ $tax_qv ] );
563 }
564 }
565
566 // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
567 $res = $wpdb->get_results( $select . $join . $where . $groupby, ARRAY_A );
568 foreach ( (array) $res as $row ) {
569 $counts[ $row['term_taxonomy_id'] ] = $row['num_posts'];
570 }
571
572 wp_cache_set( $cache_key, $counts, 'counts' );
573 }
574
575 return empty( $counts[ $lang->term_taxonomy_id ] ) ? 0 : $counts[ $lang->term_taxonomy_id ];
576 }
577
578 /**
579 * Setup the links model based on options.
580 *
581 * @since 1.2
582 *
583 * @return PLL_Links_Model
584 */
585 public function get_links_model() {
586 $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' );
587 $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default';
588
589 /**
590 * Filters the links model class to use.
591 * /!\ this filter is fired *before* the $polylang object is available.
592 *
593 * @since 2.1.1
594 *
595 * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain.
596 */
597 $class = apply_filters( 'pll_links_model', $class );
598
599 return new $class( $this );
600 }
601
602 /**
603 * Returns posts and terms ids without language ( used in settings ).
604 *
605 * @since 0.9
606 * @since 2.2.6 Add the $limit argument.
607 *
608 * @param int $limit Max number of posts or terms to return. Defaults to -1 (no limit).
609 * @return array {
610 * Objects without language.
611 *
612 * @type int[] $posts Array of post ids.
613 * @type int[] $terms Array of term ids.
614 * }
615 */
616 public function get_objects_with_no_lang( $limit = -1 ) {
617 /**
618 * Filters the max number of posts or terms to return when searching objects with no language.
619 * This filter can be used to decrease the memory usage in case the number of objects
620 * without language is too big. Using a negative value is equivalent to have no limit.
621 *
622 * @since 2.2.6
623 *
624 * @param int $limit Max number of posts or terms to retrieve from the database.
625 */
626 $limit = (int) apply_filters( 'get_objects_with_no_lang_limit', $limit );
627
628 $posts = $this->get_posts_with_no_lang( $this->get_translated_post_types(), $limit );
629 $terms = $this->get_terms_with_no_lang( $this->get_translated_taxonomies(), $limit );
630
631 /**
632 * Filters the list of untranslated posts ids and terms ids
633 *
634 * @since 0.9
635 *
636 * @param array|false $objects false if no ids found, list of post and/or term ids otherwise.
637 */
638 return apply_filters( 'pll_get_objects_with_no_lang', empty( $posts ) && empty( $terms ) ? false : array( 'posts' => $posts, 'terms' => $terms ) );
639 }
640
641 /**
642 * Returns ids of post without language.
643 *
644 * @since 3.1
645 *
646 * @param string|string[] $post_types A translated post type or an array of translated post types.
647 * @param int $limit Max number of posts to return.
648 * @return int[]
649 */
650 public function get_posts_with_no_lang( $post_types, $limit ) {
651 return get_posts(
652 array(
653 'numberposts' => $limit,
654 'nopaging' => $limit <= 0,
655 'post_type' => $post_types,
656 'post_status' => 'any',
657 'fields' => 'ids',
658 'tax_query' => array(
659 array(
660 'taxonomy' => 'language',
661 'terms' => $this->get_languages_list( array( 'fields' => 'term_id' ) ),
662 'operator' => 'NOT IN',
663 ),
664 ),
665 )
666 );
667 }
668
669 /**
670 * Returns ids of terms without language.
671 *
672 * @since 3.1
673 *
674 * @param string|string[] $taxonomies A translated taxonomy or an array of taxonomies post types.
675 * @param int $limit Max number of terms to return.
676 * @return int[]
677 */
678 public function get_terms_with_no_lang( $taxonomies, $limit ) {
679 global $wpdb;
680
681 $taxonomies = (array) $taxonomies;
682
683 $sql = sprintf(
684 "SELECT {$wpdb->term_taxonomy}.term_id FROM {$wpdb->term_taxonomy}
685 WHERE taxonomy IN ('%s')
686 AND {$wpdb->term_taxonomy}.term_id NOT IN (
687 SELECT object_id FROM {$wpdb->term_relationships} WHERE term_taxonomy_id IN (%s)
688 )
689 %s",
690 implode( "','", array_map( 'esc_sql', $taxonomies ) ),
691 implode( ',', array_map( 'intval', $this->get_languages_list( array( 'fields' => 'tl_term_taxonomy_id' ) ) ) ),
692 $limit > 0 ? sprintf( 'LIMIT %d', intval( $limit ) ) : ''
693 );
694
695 $key = md5( $sql );
696 $last_changed = wp_cache_get_last_changed( 'terms' );
697 $cache_key = "terms_no_lang:{$key}:{$last_changed}";
698
699 $term_ids = wp_cache_get( $cache_key, 'terms' );
700
701 if ( false === $term_ids ) {
702 $term_ids = $wpdb->get_col( $sql ); // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
703 wp_cache_set( $cache_key, $term_ids, 'terms' );
704 }
705
706 return $term_ids;
707 }
708
709 /**
710 * Filters the ORDERBY clause of the languages query.
711 * This allows to order languages by `term_group` and `term_id`.
712 *
713 * @since 3.2.3
714 *
715 * @param string $orderby `ORDERBY` clause of the terms query.
716 * @param array $args An array of term query arguments.
717 * @param string[] $taxonomies An array of taxonomy names.
718 * @return string
719 */
720 public function filter_language_terms_orderby( $orderby, $args, $taxonomies ) {
721 if ( ! is_array( $taxonomies ) || count( $taxonomies ) > 1 ) {
722 return $orderby;
723 }
724
725 if ( 'language' !== reset( $taxonomies ) ) {
726 return $orderby;
727 }
728
729 if ( empty( $orderby ) || ! is_string( $orderby ) ) {
730 return $orderby;
731 }
732
733 if ( ! preg_match( '@^(?<alias>[^.]+)\.term_group$@', $orderby, $matches ) ) {
734 return $orderby;
735 }
736
737 return sprintf( '%1$s.term_group, %1$s.term_id', $matches['alias'] );
738 }
739
740 /**
741 * Returns the list of existing language terms.
742 * - Returns all terms, that are or not assigned to posts.
743 * - Terms are ordered by `term_group` and `term_id` (see `PLL_Model->filter_language_terms_orderby()`).
744 *
745 * @since 3.2.3
746 *
747 * @return array<WP_Term>
748 */
749 protected function get_language_terms() {
750 add_filter( 'get_terms_orderby', array( $this, 'filter_language_terms_orderby' ), 10, 3 );
751 $post_languages = get_terms( array( 'taxonomy' => 'language', 'hide_empty' => false, 'orderby' => 'term_group' ) );
752 remove_filter( 'get_terms_orderby', array( $this, 'filter_language_terms_orderby' ) );
753
754 return empty( $post_languages ) || is_wp_error( $post_languages ) ? array() : $post_languages;
755 }
756 }
757