PluginProbe
Polylang / 1.9.2
Polylang v1.9.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
polylang / include / model.php

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

604 lines 20.8 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 /**
4 * Setups the language and translations model based on WordPress taxonomies
5 *
6 * @since 1.2
7 */
8 class PLL_Model {
9 public $cache; // our internal non persistent cache object
10 public $options;
11 public $post, $term; // translated objects models
12
13 /**
14 * Constructor
15 * setups translated objects sub models
16 * setups filters and actions
17 *
18 * @since 1.2
19 *
20 * @param array $options Polylang options
21 */
22 public function __construct( &$options ) {
23 $this->options = &$options;
24
25 $this->cache = new PLL_Cache();
26 $this->post = new PLL_Translated_Post( $this ); // translated post sub model
27 $this->term = new PLL_Translated_Term( $this ); // translated term sub model
28
29 // we need to clean languages cache when editing a language and when modifying the permalink structure
30 add_action( 'edited_term_taxonomy', array( &$this, 'clean_languages_cache' ), 10, 2 );
31 add_action( 'update_option_permalink_structure', array( &$this, 'clean_languages_cache' ) );
32 add_action( 'update_option_siteurl', array( &$this, 'clean_languages_cache' ) );
33 add_action( 'update_option_home', array( &$this, 'clean_languages_cache' ) );
34
35 // just in case someone would like to display the language description ;- )
36 add_filter( 'language_description', '__return_empty_string' );
37 }
38
39 /**
40 * Returns the list of available languages
41 * caches the list in a db transient ( except flags ), unless PLL_CACHE_LANGUAGES is set to false
42 * caches the list ( with flags ) in the private property $languages
43 *
44 * list of parameters accepted in $args:
45 *
46 * hide_empty => hides languages with no posts if set to true ( defaults to false )
47 * fields => return only that field if set ( see PLL_Language for a list of fields )
48 *
49 * @since 0.1
50 *
51 * @param array $args
52 * @return array|string|int list of PLL_Language objects or PLL_Language object properties
53 */
54 public function get_languages_list( $args = array() ) {
55 if ( false === $languages = $this->cache->get( 'languages' ) ) {
56
57 // create the languages from taxonomies
58 if ( ( defined( 'PLL_CACHE_LANGUAGES' ) && ! PLL_CACHE_LANGUAGES ) || false === ( $languages = get_transient( 'pll_languages_list' ) ) ) {
59 $languages = get_terms( 'language', array( 'hide_empty' => false, 'orderby' => 'term_group' ) );
60 $languages = empty( $languages ) || is_wp_error( $languages ) ? array() : $languages;
61
62 $term_languages = get_terms( 'term_language', array( 'hide_empty' => false ) );
63 $term_languages = empty( $term_languages ) || is_wp_error( $term_languages ) ?
64 array() : array_combine( wp_list_pluck( $term_languages, 'slug' ), $term_languages );
65
66 if ( ! empty( $languages ) && ! empty( $term_languages ) ) {
67 // don't use array_map + create_function to instantiate an autoloaded class as it breaks badly in old versions of PHP
68 foreach ( $languages as $k => $v ) {
69 $languages[ $k ] = new PLL_Language( $v, $term_languages[ 'pll_' . $v->slug ] );
70 }
71
72 // we will need the languages list to allow its access in the filter below
73 $this->cache->set( 'languages', $languages );
74
75 /**
76 * Filter the list of languages *before* it is stored in the persistent cache
77 * /!\ this filter is fired *before* the $polylang object is available
78 *
79 * @since 1.7.5
80 *
81 * @param array $languages the list of language objects
82 * @param object $model PLL_Model object
83 */
84 $languages = apply_filters( 'pll_languages_list', $languages, $this );
85
86 // don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache
87 // thanks to captin411 for catching this!
88 // see https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255;
89 set_transient( 'pll_languages_list', array_map( 'get_object_vars', $languages ) );
90 }
91 else {
92 $languages = array(); // in case something went wrong
93 }
94 }
95
96 // create the languages directly from arrays stored in transients
97 else {
98 foreach ( $languages as $k => $v ) {
99 $languages[ $k ] = new PLL_Language( $v );
100 }
101 }
102
103 // custom flags
104 if ( ! PLL_ADMIN ) {
105 foreach ( $languages as $language ) {
106 $language->set_custom_flag();
107 }
108 }
109
110 /**
111 * Filter the list of languages *after* it is stored in the persistent cache
112 * /!\ this filter is fired *before* the $polylang object is available
113 *
114 * @since 1.8
115 *
116 * @param array $languages the list of language objects
117 */
118 $languages = apply_filters( 'pll_after_languages_cache', $languages );
119 $this->cache->set( 'languages', $languages );
120 }
121
122 $args = wp_parse_args( $args, array( 'hide_empty' => false ) );
123
124 // remove empty languages if requested
125 if ( $args['hide_empty'] ) {
126 $languages = wp_list_filter( $languages, array( 'count' => 0 ), 'NOT' );
127 }
128
129 return empty( $args['fields'] ) ? $languages : wp_list_pluck( $languages, $args['fields'] );
130 }
131
132 /**
133 * Cleans language cache
134 * can be called directly with no parameter
135 * called by the 'edited_term_taxonomy' filter with 2 parameters when count needs to be updated
136 *
137 * @since 1.2
138 *
139 * @param int $term not used
140 * @param string $taxonomy taxonomy name
141 */
142 public function clean_languages_cache( $term = 0, $taxonomy = null ) {
143 // depending on WP version, the action is passed an object or a string
144 // backward compatibility with WP < 4.2
145 if ( ! empty( $taxonomy ) && is_object( $taxonomy ) ) {
146 $taxonomy = $taxonomy->name;
147 }
148
149 if ( empty( $taxonomy ) || 'language' == $taxonomy ) {
150 delete_transient( 'pll_languages_list' );
151 $this->cache->clean();
152 }
153 }
154
155 /**
156 * Returns the language by its term_id, tl_term_id, slug or locale
157 *
158 * @since 0.1
159 *
160 * @param int|string term_id, tl_term_id, slug or locale of the queried language
161 * @return object|bool PLL_Language object, false if no language found
162 */
163 public function get_language( $value ) {
164 if ( is_object( $value ) ) {
165 return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // will force cast to PLL_Language
166 }
167
168 if ( false === $return = $this->cache->get( 'language:' . $value ) ) {
169 foreach ( $this->get_languages_list() as $lang ) {
170 $this->cache->set( 'language:' . $lang->term_id, $lang );
171 $this->cache->set( 'language:' . $lang->tl_term_id, $lang );
172 $this->cache->set( 'language:' . $lang->slug, $lang );
173 $this->cache->set( 'language:' . $lang->locale, $lang );
174 }
175 $return = $this->cache->get( 'language:' . $value );
176 }
177
178 return $return;
179 }
180
181 /**
182 * Adds terms clauses to get_terms to filter them by languages - used in both frontend and admin
183 *
184 * @since 1.2
185 *
186 * @param array $clauses the list of sql clauses in terms query
187 * @param object $lang PLL_Language object
188 * @return array modifed list of clauses
189 */
190 public function terms_clauses( $clauses, $lang ) {
191 if ( ! empty( $lang ) ) {
192 $clauses['join'] .= $this->term->join_clause();
193 $clauses['where'] .= $this->term->where_clause( $lang );
194 }
195 return $clauses;
196 }
197
198 /**
199 * Returns post types that need to be translated
200 * the post types list is cached for better better performance
201 * wait for 'after_setup_theme' to apply the cache to allow themes adding the filter in functions.php
202 *
203 * @since 1.2
204 *
205 * @param bool $filter true if we should return only valid registered post types
206 * @return array post type names for which Polylang manages languages and translations
207 */
208 public function get_translated_post_types( $filter = true ) {
209 if ( false === $post_types = $this->cache->get( 'post_types' ) ) {
210 $post_types = array( 'post' => 'post', 'page' => 'page' );
211
212 if ( ! empty( $this->options['media_support'] ) ) {
213 $post_types['attachement'] = 'attachment';
214 }
215
216 if ( ! empty( $this->options['post_types'] ) && is_array( $this->options['post_types'] ) ) {
217 $post_types = array_merge( $post_types, array_combine( $this->options['post_types'], $this->options['post_types'] ) );
218 }
219
220 /**
221 * Filter the list of post types available for translation.
222 * The default are post types which have the parameter ‘public’ set to true.
223 * The filter must be added soon in the WordPress loading process:
224 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
225 *
226 * @since 0.8
227 *
228 * @param array $post_types list of post type names
229 * @param bool $is_settings true when displaying the list of custom post types in Polylang settings
230 */
231 $post_types = apply_filters( 'pll_get_post_types', $post_types, false );
232
233 if ( did_action( 'after_setup_theme' ) ) {
234 $this->cache->set( 'post_types', $post_types );
235 }
236 }
237
238 return $filter ? array_intersect( $post_types, get_post_types() ) : $post_types;
239 }
240
241 /**
242 * Returns true if Polylang manages languages and translations for this post type
243 *
244 * @since 1.2
245 *
246 * @param string|array $post_type post type name or array of post type names
247 * @return bool
248 */
249 public function is_translated_post_type( $post_type ) {
250 $post_types = $this->get_translated_post_types( false );
251 return ( is_array( $post_type ) && array_intersect( $post_type, $post_types ) || in_array( $post_type, $post_types ) );
252 }
253
254 /**
255 * Return taxonomies that need to be translated
256 *
257 * @since 1.2
258 *
259 * @param bool $filter true if we should return only valid registered taxonmies
260 * @return array array of registered taxonomy names for which Polylang manages languages and translations
261 */
262 public function get_translated_taxonomies( $filter = true ) {
263 if ( false === $taxonomies = $this->cache->get( 'taxonomies' ) ) {
264 $taxonomies = array( 'category' => 'category', 'post_tag' => 'post_tag' );
265
266 if ( ! empty( $this->options['taxonomies'] ) && is_array( $this->options['taxonomies'] ) ) {
267 $taxonomies = array_merge( $taxonomies, array_combine( $this->options['taxonomies'], $this->options['taxonomies'] ) );
268 }
269
270 /**
271 * Filter the list of taxonomies available for translation.
272 * The default are taxonomies which have the parameter ‘public’ set to true.
273 * The filter must be added soon in the WordPress loading process:
274 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
275 *
276 * @since 0.8
277 *
278 * @param array $taxonomies list of taxonomy names
279 * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings
280 */
281 $taxonomies = apply_filters( 'pll_get_taxonomies', $taxonomies, false );
282 if ( did_action( 'after_setup_theme' ) ) {
283 $this->cache->set( 'taxonomies', $taxonomies );
284 }
285 }
286
287 return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies;
288 }
289
290 /**
291 * Returns true if Polylang manages languages and translations for this taxonomy
292 *
293 * @since 1.2
294 *
295 * @param string|array $tax taxonomy name or array of taxonomy names
296 * @return bool
297 */
298 public function is_translated_taxonomy( $tax ) {
299 $taxonomies = $this->get_translated_taxonomies( false );
300 return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) );
301 }
302
303 /**
304 * Return taxonomies that need to be filtered ( post_format like )
305 *
306 * @since 1.7
307 *
308 * @param bool $filter true if we should return only valid registered taxonomies
309 * @return array array of registered taxonomy names
310 */
311 public function get_filtered_taxonomies( $filter = true ) {
312 if ( did_action( 'after_setup_theme' ) ) {
313 static $taxonomies = null;
314 }
315
316 if ( empty( $taxonomies ) ) {
317 $taxonomies = array( 'post_format' => 'post_format' );
318
319 /**
320 * Filter the list of taxonomies not translatable but filtered by language.
321 * Includes only the post format by default
322 * The filter must be added soon in the WordPress loading process:
323 * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes.
324 *
325 * @since 1.7
326 *
327 * @param array $taxonomies list of taxonomy names
328 * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings
329 */
330 $taxonomies = apply_filters( 'pll_filtered_taxonomies', $taxonomies, false );
331 }
332
333 return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies;
334 }
335
336 /**
337 * Returns true if Polylang filters this taxonomy per language
338 *
339 * @since 1.7
340 *
341 * @param string|array $tax taxonomy name or array of taxonomy names
342 * @return bool
343 */
344 public function is_filtered_taxonomy( $tax ) {
345 $taxonomies = $this->get_filtered_taxonomies( false );
346 return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) );
347 }
348
349 /**
350 * Returns the query vars of all filtered taxonomies
351 *
352 * @since 1.7
353 *
354 * @return array
355 */
356 public function get_filtered_taxonomies_query_vars() {
357 $query_vars = array();
358 foreach ( $this->get_filtered_taxonomies() as $filtered_tax ) {
359 $tax = get_taxonomy( $filtered_tax );
360 $query_vars[] = $tax->query_var;
361 }
362 return $query_vars;
363 }
364
365 /**
366 * Create a default category for a language
367 *
368 * @since 1.2
369 *
370 * @param object|string|int $lang language
371 */
372 public function create_default_category( $lang ) {
373 $lang = $this->get_language( $lang );
374
375 // create a new category
376 // FIXME this is translated in admin language when we would like it in $lang
377 $cat_name = __( 'Uncategorized' );
378 $cat_slug = sanitize_title( $cat_name . '-' . $lang->slug );
379 $cat = wp_insert_term( $cat_name, 'category', array( 'slug' => $cat_slug ) );
380
381 // check that the category was not previously created ( in case the language was deleted and recreated )
382 $cat = isset( $cat->error_data['term_exists'] ) ? $cat->error_data['term_exists'] : $cat['term_id'];
383
384 // set language
385 $this->term->set_language( (int) $cat, $lang );
386
387 // this is a translation of the default category
388 $default = (int) get_option( 'default_category' );
389 $translations = $this->term->get_translations( $default );
390 if ( empty( $translations ) ) {
391 if ( $lg = $this->term->get_language( $default ) ) {
392 $translations[ $lg->slug ] = $default;
393 }
394 else {
395 $translations = array();
396 }
397 }
398
399 $this->term->save_translations( (int) $cat, $translations );
400 }
401
402 /**
403 * It is possible to have several terms with the same name in the same taxonomy ( one per language )
404 * but the native term_exists will return true even if only one exists
405 * so here the function adds the language parameter
406 *
407 * @since 1.4
408 *
409 * @param string $term_name the term name
410 * @param string $taxonomy taxonomy name
411 * @param int $parent parent term id
412 * @param string|object $language the language slug or object
413 * @return null|int the term_id of the found term
414 */
415 public function term_exists( $term_name, $taxonomy, $parent, $language ) {
416 global $wpdb;
417
418 $term_name = trim( wp_unslash( $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 return $wpdb->get_var( $select . $join . $where );
431 }
432
433 /**
434 * Gets the number of posts per language in a date, author or post type archive
435 *
436 * @since 1.2
437 *
438 * @param object $lang
439 * @param array $q WP_Query arguments ( accepted: post_type, m, year, monthnum, day, author, author_name, post_format )
440 * @return int
441 */
442 public function count_posts( $lang, $q = array() ) {
443 global $wpdb;
444
445 $q = wp_parse_args( $q, array( 'post_type' => 'post' ) );
446
447 if ( ! is_array( $q['post_type'] ) ) {
448 $q['post_type'] = array( $q['post_type'] );
449 }
450
451 foreach ( $q['post_type'] as $key => $type ) {
452 if ( ! post_type_exists( $type ) ) {
453 unset( $q['post_type'][ $key ] );
454 }
455 }
456
457 if ( empty( $q['post_type'] ) ) {
458 $q['post_type'] = array( 'post' ); // we *need* a post type
459 }
460
461 $cache_key = md5( serialize( $q ) );
462 $counts = wp_cache_get( $cache_key, 'pll_count_posts' );
463
464 if ( false === $counts ) {
465 $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts} AS p";
466 $join = $this->post->join_clause();
467 $where = " WHERE post_status = 'publish'";
468 $where .= $wpdb->prepare( " AND p.post_type IN ( '%s' )", join( "', '", $q['post_type'] ) );
469 $where .= $this->post->where_clause( $this->get_languages_list() );
470 $groupby = ' GROUP BY pll_tr.term_taxonomy_id';
471
472 if ( ! empty( $q['m'] ) ) {
473 $q['m'] = '' . preg_replace( '|[^0-9]|', '', $q['m'] );
474 $where .= $wpdb->prepare( ' AND YEAR( p.post_date ) = %d', substr( $q['m'], 0, 4 ) );
475 if ( strlen( $q['m'] ) > 5 ) {
476 $where .= $wpdb->prepare( ' AND MONTH( p.post_date ) = %d', substr( $q['m'], 4, 2 ) );
477 }
478 if ( strlen( $q['m'] ) > 7 ) {
479 $where .= $wpdb->prepare( ' AND DAYOFMONTH( p.post_date ) = %d', substr( $q['m'], 6, 2 ) );
480 }
481 }
482
483 if ( ! empty( $q['year'] ) ) {
484 $where .= $wpdb->prepare( ' AND YEAR( p.post_date ) = %d', $q['year'] );
485 }
486
487 if ( ! empty( $q['monthnum'] ) ) {
488 $where .= $wpdb->prepare( ' AND MONTH( p.post_date ) = %d', $q['monthnum'] );
489 }
490
491 if ( ! empty( $q['day'] ) ) {
492 $where .= $wpdb->prepare( ' AND DAYOFMONTH( p.post_date ) = %d', $q['day'] );
493 }
494
495 if ( ! empty( $q['author_name'] ) ) {
496 $author = get_user_by( 'slug', sanitize_title_for_query( $q['author_name'] ) );
497 if ( $author ) {
498 $q['author'] = $author->ID;
499 }
500 }
501
502 if ( ! empty( $q['author'] ) ) {
503 $where .= $wpdb->prepare( ' AND p.post_author = %d', $q['author'] );
504 }
505
506 // filtered taxonomies ( post_format )
507 foreach ( $this->get_filtered_taxonomies_query_vars() as $tax_qv ) {
508
509 if ( ! empty( $q[ $tax_qv ] ) ) {
510 $join .= " INNER JOIN {$wpdb->term_relationships} AS tr ON tr.object_id = p.ID";
511 $join .= " INNER JOIN {$wpdb->term_taxonomy} AS tt ON tt.term_taxonomy_id = tr.term_taxonomy_id";
512 $join .= " INNER JOIN {$wpdb->terms} AS t ON t.term_id = tt.term_id";
513 $where .= $wpdb->prepare( ' AND t.slug = %s', $q[ $tax_qv ] );
514 }
515 }
516
517 $res = $wpdb->get_results( $select . $join . $where . $groupby, ARRAY_A );
518 foreach ( (array) $res as $row ) {
519 $counts[ $row['term_taxonomy_id'] ] = $row['num_posts'];
520 }
521
522 wp_cache_set( $cache_key, $counts, 'pll_count_posts' );
523 }
524
525 return empty( $counts[ $lang->term_taxonomy_id ] ) ? 0 : $counts[ $lang->term_taxonomy_id ];
526 }
527
528 /**
529 * Setup the links model based on options
530 *
531 * @since 1.2
532 *
533 * @return object implementing "links_model interface"
534 */
535 public function get_links_model() {
536 $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' );
537 $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default';
538 return new $class( $this );
539 }
540
541 /**
542 * Some backward compatibility with Polylang < 1.8
543 * allows for example to call $polylang->model->get_post_languages( $post_id ) instead of $polylang->model->post->get_language( $post_id )
544 * this works but should be slower than the direct call, thus an error is triggered in debug mode
545 *
546 * @since 1.8
547 *
548 * @param string $func function name
549 * @param array $args function arguments
550 */
551 public function __call( $func, $args ) {
552 $f = $func;
553
554 switch ( $func ) {
555 case 'get_object_term':
556 $o = false === strpos( $args[1], 'term' ) ? 'post' : 'term';
557 break;
558
559 case 'save_translations':
560 case 'delete_translation':
561 case 'get_translations':
562 case 'get_translation':
563 case 'join_clause':
564 $o = ( 'post' == $args[0] || $this->is_translated_post_type( $args[0] ) ) ? 'post' : ( 'term' == $args[0] || $this->is_translated_taxonomy( $args[0] ) ? 'term' : false );
565 unset( $args[0] );
566 break;
567
568 case 'set_post_language':
569 case 'get_post_language':
570 case 'set_term_language':
571 case 'get_term_language':
572 case 'delete_term_language':
573 case 'get_post':
574 case 'get_term':
575 $str = explode( '_', $func );
576 $f = empty( $str[2] ) ? $str[0] : $str[0] . '_' . $str[2];
577 $o = $str[1];
578 break;
579
580 case 'where_clause':
581 case 'get_objects_in_language':
582 $o = $args[1];
583 unset( $args[1] );
584 break;
585 }
586
587 if ( ! empty( $o ) && is_object( $this->$o ) && method_exists( $this->$o, $f ) ) {
588 if ( WP_DEBUG ) {
589 $debug = debug_backtrace();
590 $i = 1 + empty( $debug[1]['line'] ); // the file and line are in $debug[2] if the function was called using call_user_func
591
592 trigger_error( sprintf(
593 '%1$s was called incorrectly in %4$s on line %5$s: the call to $polylang->model->%1$s() has been deprecated in Polylang 1.8, use PLL()->model->%2$s->%3$s() instead.' . "\nError handler",
594 $func, $o, $f, $debug[ $i ]['file'], $debug[ $i ]['line']
595 ) );
596 }
597 return call_user_func_array( array( $this->$o, $f ), $args );
598 }
599
600 $debug = debug_backtrace();
601 trigger_error( sprintf( 'Call to undefined function PLL()->model->%1$s() in %2$s on line %3$s' . "\nError handler", $func, $debug[0]['file'], $debug[0]['line'] ), E_USER_ERROR );
602 }
603 }
604