PluginProbe
Polylang / 2.5
Polylang v2.5
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 | include/language.php +125 -341 3.02.5 View file →
@@ -1,222 +1,88 @@
1 1 <?php
2 -/**
3 - * @package Polylang
4 - */
5 2
6 3 /**
7 - * A language object is made of two terms in 'language' and 'term_language' taxonomies.
8 - * Manipulating only one object per language instead of two terms should make things easier.
4 + * A language object is made of two terms in 'language' and 'term_language' taxonomies
5 + * manipulating only one object per language instead of two terms should make things easier
9 6 *
7 + * Properties:
8 + * term_id => id of term in 'language' taxonomy
9 + * name => language name. Ex: English
10 + * slug => language code used in url. Ex: en
11 + * term_group => order of the language when displayed in a list of languages
12 + * term_taxonomy_id => term taxonomy id in 'language' taxonomy
13 + * taxonomy => 'language'
14 + * description => language locale for backward compatibility
15 + * parent => 0 / not used
16 + * count => number of posts and pages in that language
17 + * tl_term_id => id of the term in 'term_language' taxonomy
18 + * tl_term_taxonomy_id => term taxonomy id in 'term_language' taxonomy
19 + * tl_count => number of terms in that language ( not used by Polylang )
20 + * locale => WordPress language locale. Ex: en_US
21 + * is_rtl => 1 if the language is rtl
22 + * w3c => W3C locale
23 + * flag_code => code of the flag
24 + * flag_url => url of the flag
25 + * flag => html img of the flag
26 + * custom_flag_url => url of the custom flag if exists, internal use only, moves to flag_url on frontend
27 + * custom_flag => html img of the custom flag if exists, internal use only, moves to flag on frontend
28 + * home_url => home url in this language
29 + * search_url => home url to use in search forms
30 + * host => host of this language
31 + * mo_id => id of the post storing strings translations
32 + * page_on_front => id of the page on front in this language ( set from pll_languages_list filter )
33 + * page_for_posts => id of the page for posts in this language ( set from pll_languages_list filter )
34 + *
10 35 * @since 1.2
11 36 */
12 37 class PLL_Language {
13 - /**
14 - * Id of the term in 'language' taxonomy.
15 - *
16 - * @var int
17 - */
18 - public $term_id;
38 + public $term_id, $name, $slug, $term_group, $term_taxonomy_id, $taxonomy, $description, $parent, $count;
39 + public $tl_term_id, $tl_term_taxonomy_id, $tl_count;
40 + public $locale, $is_rtl;
41 + public $w3c, $facebook;
42 + public $flag_url, $flag;
43 + public $home_url, $search_url;
44 + public $host, $mo_id;
45 + public $page_on_front, $page_for_posts;
19 46
20 47 /**
21 - * Language name. Ex: English.
48 + * Constructor: builds a language object given its two corresponding terms in language and term_language taxonomies
22 49 *
23 - * @var string
24 - */
25 - public $name;
26 -
27 - /**
28 - * Language code used in url. Ex: en.
29 - *
30 - * @var string
31 - */
32 - public $slug;
33 -
34 - /**
35 - * Order of the language when displayed in a list of languages.
36 - *
37 - * @var int
38 - */
39 - public $term_group;
40 -
41 - /**
42 - * Term taxonomy id in 'language' taxonomy.
43 - *
44 - * @var int
45 - */
46 - public $term_taxonomy_id;
47 -
48 - /**
49 - * Number of posts and pages in that language.
50 - *
51 - * @var int
52 - */
53 - public $count;
54 -
55 - /**
56 - * Id of the term in 'term_language' taxonomy.
57 - *
58 - * @var int
59 - */
60 - public $tl_term_id;
61 -
62 - /**
63 - * Term taxonomy id in 'term_language' taxonomy.
64 - *
65 - * @var int
66 - */
67 - public $tl_term_taxonomy_id;
68 -
69 - /**
70 - * Number of terms in that language.
71 - *
72 - * @var int
73 - */
74 - public $tl_count;
75 -
76 - /**
77 - * WordPress language locale. Ex: en_US.
78 - *
79 - * @var string
80 - */
81 - public $locale;
82 -
83 - /**
84 - * 1 if the language is rtl, 0 otherwise.
85 - *
86 - * @var int
87 - */
88 - public $is_rtl;
89 -
90 - /**
91 - * W3C locale.
92 - *
93 - * @var string.
94 - */
95 - public $w3c;
96 -
97 - /**
98 - * Facebook locale.
99 - *
100 - * @var string.
101 - */
102 - public $facebook;
103 -
104 - /**
105 - * Home url in this language.
106 - *
107 - * @var string
108 - */
109 - public $home_url;
110 -
111 - /**
112 - * Home url to use in search forms.
113 - *
114 - * @var string
115 - */
116 - public $search_url;
117 -
118 - /**
119 - * Host corresponding to this language.
120 - *
121 - * @var string
122 - */
123 - public $host;
124 -
125 - /**
126 - * Id of the post storing strings translations.
127 - *
128 - * @var int
129 - */
130 - public $mo_id;
131 -
132 - /**
133 - * Id of the page on front in this language ( set from pll_languages_list filter ).
134 - *
135 - * @var int
136 - */
137 - public $page_on_front;
138 -
139 - /**
140 - * Id of the page for posts in this language ( set from pll_languages_list filter ).
141 - *
142 - * @var int
143 - */
144 - public $page_for_posts;
145 -
146 - /**
147 - * Code of the flag.
148 - *
149 - * @var string
150 - */
151 - public $flag_code;
152 -
153 - /**
154 - * Url of the flag.
155 - *
156 - * @var string
157 - */
158 - public $flag_url;
159 -
160 - /**
161 - * Html markup of the flag.
162 - *
163 - * @var string
164 - */
165 - public $flag;
166 -
167 - /**
168 - * Url of the custom flag if it exists.
169 - *
170 - * @var string
171 - */
172 - protected $custom_flag_url;
173 -
174 - /**
175 - * Html markup of the custom flag if it exists.
176 - *
177 - * @var string
178 - */
179 - protected $custom_flag;
180 -
181 - /**
182 - * Constructor: builds a language object given its two corresponding terms in 'language' and 'term_language' taxonomies.
183 - *
184 50 * @since 1.2
185 51 *
186 - * @param WP_Term|array $language Term in 'language' taxonomy or language object properties stored as an array.
187 - * @param WP_Term $term_language Corresponding 'term_language' term.
52 + * @param object|array $language 'language' term or language object properties stored as an array
53 + * @param object $term_language Corresponding 'term_language' term
188 54 */
189 55 public function __construct( $language, $term_language = null ) {
190 - // Build the object from all properties stored as an array.
191 - if ( is_array( $language ) ) {
56 + // Build the object from all properties stored as an array
57 + if ( empty( $term_language ) ) {
192 58 foreach ( $language as $prop => $value ) {
193 59 $this->$prop = $value;
194 60 }
195 61 }
196 62
197 - // Build the object from taxonomy terms.
198 - elseif ( ! empty( $term_language ) ) {
199 - $this->term_id = (int) $language->term_id;
200 - $this->name = $language->name;
201 - $this->slug = $language->slug;
202 - $this->term_group = (int) $language->term_group;
203 - $this->term_taxonomy_id = (int) $language->term_taxonomy_id;
204 - $this->count = (int) $language->count;
63 + // Build the object from taxonomies
64 + else {
65 + foreach ( $language as $prop => $value ) {
66 + $this->$prop = in_array( $prop, array( 'term_id', 'term_taxonomy_id', 'count' ) ) ? (int) $language->$prop : $language->$prop;
67 + }
205 68
206 69 $this->tl_term_id = (int) $term_language->term_id;
207 70 $this->tl_term_taxonomy_id = (int) $term_language->term_taxonomy_id;
208 71 $this->tl_count = (int) $term_language->count;
209 72
210 - // The description field can contain any property.
73 + // The description field can contain any property
74 + // Backward compatibility for is_rtl
211 75 $description = maybe_unserialize( $language->description );
212 76 foreach ( $description as $prop => $value ) {
213 77 'rtl' == $prop ? $this->is_rtl = $value : $this->$prop = $value;
214 78 }
215 79
80 + $this->description = &$this->locale; // Backward compatibility with Polylang < 1.2
81 +
216 82 $this->mo_id = PLL_MO::get_id( $this );
217 83
218 - $languages = include POLYLANG_DIR . '/settings/languages.php';
84 + include PLL_SETTINGS_INC . '/languages.php';
219 85 $this->w3c = isset( $languages[ $this->locale ]['w3c'] ) ? $languages[ $this->locale ]['w3c'] : str_replace( '_', '-', $this->locale );
220 86 if ( isset( $languages[ $this->locale ]['facebook'] ) ) {
221 87 $this->facebook = $languages[ $this->locale ]['facebook'];
222 88 }
@@ -223,74 +89,46 @@
223 89 }
224 90 }
225 91
226 92 /**
227 - * Get the flag informations:
93 + * Sets flag_url and flag properties
228 94 *
229 - * @since 2.6
230 - *
231 - * @param string $code Flag code.
232 - * @return array {
233 - * Flag informations.
234 - *
235 - * @type string $url Flag url.
236 - * @type string $src Optional, src attribute value if different of the url, for example if base64 encoded.
237 - * @type int $width Optional, flag width in pixels.
238 - * @type int $height Optional, flag height in pixels.
239 - * }
95 + * @since 1.2
240 96 */
241 - public static function get_flag_informations( $code ) {
242 - $flag = array( 'url' => '' );
97 + public function set_flag() {
98 + $flags['flag']['url'] = '';
243 99
244 - // Polylang builtin flags.
245 - if ( ! empty( $code ) && file_exists( POLYLANG_DIR . ( $file = '/flags/' . $code . '.png' ) ) ) {
246 - $flag['url'] = plugins_url( $file, POLYLANG_FILE );
247 -
248 - // If base64 encoded flags are preferred.
249 - if ( ! defined( 'PLL_ENCODED_FLAGS' ) || PLL_ENCODED_FLAGS ) {
250 - list( $flag['width'], $flag['height'] ) = getimagesize( POLYLANG_DIR . $file );
251 - $file_contents = file_get_contents( POLYLANG_DIR . $file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
252 - $flag['src'] = 'data:image/png;base64,' . base64_encode( $file_contents ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
253 - }
100 + // Polylang builtin flags
101 + if ( ! empty( $this->flag_code ) && file_exists( POLYLANG_DIR . ( $file = '/flags/' . $this->flag_code . '.png' ) ) ) {
102 + $flags['flag']['url'] = $_url = plugins_url( $file, POLYLANG_FILE );
254 103 }
255 104
256 105 /**
257 - * Filters flag informations:
106 + * Filter flag informations
107 + * 'url' => Flag url
108 + * 'src' => Optional, src attribute value if different of the url, for example if base64 encoded
109 + * 'width' => Optional, flag width in pixels
110 + * 'height' => Optional, flag height in pixels
258 111 *
259 112 * @since 2.4
260 113 *
261 - * @param array $flag {
262 - * Information about the flag.
263 - *
264 - * @type string $url Flag url.
265 - * @type string $src Optional, src attribute value if different of the url, for example if base64 encoded.
266 - * @type int $width Optional, flag width in pixels.
267 - * @type int $height Optional, flag height in pixels.
268 - * }
269 - * @param string $code Flag code.
114 + * @param array $flag Information about the flag
115 + * @param string $code Flag code
270 116 */
271 - $flag = apply_filters( 'pll_flag', $flag, $code );
117 + $flags['flag'] = apply_filters( 'pll_flag', $flags['flag'], $this->flag_code );
272 118
273 - $flag['url'] = esc_url_raw( $flag['url'] );
274 -
275 - if ( empty( $flag['src'] ) ) {
276 - $flag['src'] = esc_url( set_url_scheme( $flag['url'], 'relative' ) );
119 + if ( empty( $flags['flag']['src'] ) ) {
120 + // If using predefined flags and base64 encoded flags are preferred
121 + if ( isset( $_url ) && $flags['flag']['url'] === $_url && ( ! defined( 'PLL_ENCODED_FLAGS' ) || PLL_ENCODED_FLAGS ) ) {
122 + $flags['flag']['src'] = 'data:image/png;base64,' . base64_encode( file_get_contents( POLYLANG_DIR . $file ) );
123 + } else {
124 + $flags['flag']['src'] = esc_url( set_url_scheme( $flags['flag']['url'], 'relative' ) );
125 + }
277 126 }
278 127
279 - return $flag;
280 - }
128 + $flags['flag']['url'] = esc_url_raw( $flags['flag']['url'] );
281 129
282 - /**
283 - * Sets flag_url and flag properties.
284 - *
285 - * @since 1.2
286 - *
287 - * @return void
288 - */
289 - public function set_flag() {
290 - $flags = array( 'flag' => self::get_flag_informations( $this->flag_code ) );
291 -
292 - // Custom flags?
130 + // Custom flags ?
293 131 $directories = array(
294 132 PLL_LOCAL_DIR,
295 133 get_stylesheet_directory() . '/polylang',
296 134 get_template_directory() . '/polylang',
@@ -303,21 +141,18 @@
303 141 }
304 142 }
305 143
306 144 /**
307 - * Filters the custom flag informations.
145 + * Filter the custom flag informations
146 + * 'url' => Flag url
147 + * 'src' => Optional, src attribute value if different of the url, for example if base64 encoded
148 + * 'width' => Optional, flag width in pixels
149 + * 'height' => Optional, flag height in pixels
308 150 *
309 - * @param array $flag {
310 - * Information about the custom flag.
151 + * @since 2.4
311 152 *
312 - * @type string $url Flag url.
313 - * @type string $src Optional, src attribute value if different of the url, for example if base64 encoded.
314 - * @type int $width Optional, flag width in pixels.
315 - * @type int $height Optional, flag height in pixels.
316 - * }
317 - * @param string $code Flag code.
318 - *
319 - * @since 2.4
153 + * @param array $flag Information about the custom flag
154 + * @param string $code Flag code
320 155 */
321 156 $flags['custom_flag'] = apply_filters( 'pll_custom_flag', empty( $flags['custom_flag'] ) ? null : $flags['custom_flag'], $this->flag_code );
322 157
323 158 if ( ! empty( $flags['custom_flag']['url'] ) ) {
@@ -330,16 +165,16 @@
330 165 unset( $flags['custom_flag'] );
331 166 }
332 167
333 168 /**
334 - * Filters the flag title attribute.
335 - * Defaults to the language name.
169 + * Filter the flag title attribute
170 + * Defaults to the language name
336 171 *
337 172 * @since 0.7
338 173 *
339 - * @param string $title The flag title attribute.
340 - * @param string $slug The language code.
341 - * @param string $locale The language locale.
174 + * @param string $title the flag title attribute
175 + * @param string $slug the language code
176 + * @param string $locale the language locale
342 177 */
343 178 $title = apply_filters( 'pll_flag_title', $this->name, $this->slug, $this->locale );
344 179
345 180 foreach ( $flags as $key => $flag ) {
@@ -345,18 +180,25 @@
345 180 foreach ( $flags as $key => $flag ) {
346 181 $this->{$key . '_url'} = empty( $flag['url'] ) ? '' : $flag['url'];
347 182
348 183 /**
349 - * Filters the html markup of a flag.
184 + * Filter the html markup of a flag
350 185 *
351 186 * @since 1.0.2
352 187 *
353 - * @param string $flag Html markup of the flag or empty string.
354 - * @param string $slug Language code.
188 + * @param string $flag html markup of the flag or empty string
189 + * @param string $slug language code
355 190 */
356 191 $this->{$key} = apply_filters(
357 192 'pll_get_flag',
358 - self::get_flag_html( $flag, $title, $this->name ),
193 + empty( $flag['src'] ) ? '' : sprintf(
194 + '<img src="%s" title="%s" alt="%s"%s%s />',
195 + $flag['src'],
196 + esc_attr( $title ),
197 + esc_attr( $this->name ),
198 + empty( $flag['width'] ) ? '' : sprintf( ' width="%s"', (int) $flag['width'] ),
199 + empty( $flag['height'] ) ? '' : sprintf( ' height="%s"', (int) $flag['height'] )
200 + ),
359 201 $this->slug
360 202 );
361 203 }
362 204 }
@@ -361,91 +203,42 @@
361 203 }
362 204 }
363 205
364 206 /**
365 - * Get HTML code for flag.
207 + * Replace flag by custom flag
208 + * Takes care of url scheme
366 209 *
367 - * @since 2.7
368 - *
369 - * @param array $flag Flag properties: src, width and height.
370 - * @param string $title Optional title attribute.
371 - * @param string $alt Optional alt attribute.
372 - * @return string
210 + * @since 1.7
373 211 */
374 - public static function get_flag_html( $flag, $title = '', $alt = '' ) {
375 - if ( empty( $flag['src'] ) ) {
376 - return '';
212 + public function set_custom_flag() {
213 + // Overwrite with custom flags on frontend only
214 + if ( ! empty( $this->custom_flag ) ) {
215 + $this->flag = $this->custom_flag;
216 + $this->flag_url = $this->custom_flag_url;
217 + unset( $this->custom_flag, $this->custom_flag_url ); // hide this
377 218 }
378 219
379 - $alt_attr = empty( $alt ) ? '' : sprintf( ' alt="%s"', esc_attr( $alt ) );
380 - $width_attr = empty( $flag['width'] ) ? '' : sprintf( ' width="%s"', (int) $flag['width'] );
381 - $height_attr = empty( $flag['height'] ) ? '' : sprintf( ' height="%s"', (int) $flag['height'] );
382 -
383 - $style = '';
384 - $sizes = array_intersect_key( $flag, array_flip( array( 'width', 'height' ) ) );
385 -
386 - if ( ! empty( $sizes ) ) {
387 - array_walk(
388 - $sizes,
389 - function ( &$value, $key ) {
390 - $value = sprintf( '%s: %dpx;', esc_attr( $key ), (int) $value );
391 - }
392 - );
393 - $style = sprintf( ' style="%s"', implode( ' ', $sizes ) );
394 - }
395 -
396 - return sprintf(
397 - '<img src="%s"%s%s%s%s />',
398 - $flag['src'],
399 - $alt_attr,
400 - $width_attr,
401 - $height_attr,
402 - $style
403 - );
220 + // Set url scheme, also for default flags
221 + $this->flag_url = set_url_scheme( $this->flag_url );
404 222 }
405 223
406 224 /**
407 - * Returns the html of the custom flag if any, or the default flag otherwise.
225 + * Updates post and term count
408 226 *
409 - * @since 2.8
410 - *
411 - * @return string
412 - */
413 - public function get_display_flag() {
414 - return empty( $this->custom_flag ) ? $this->flag : $this->custom_flag;
415 - }
416 -
417 - /**
418 - * Returns the url of the custom flag if any, or the default flag otherwise.
419 - *
420 - * @since 2.8
421 - *
422 - * @return string
423 - */
424 - public function get_display_flag_url() {
425 - return empty( $this->custom_flag_url ) ? $this->flag_url : $this->custom_flag_url;
426 - }
427 -
428 - /**
429 - * Updates post and term count.
430 - *
431 227 * @since 1.2
432 - *
433 - * @return void
434 228 */
435 229 public function update_count() {
436 - wp_update_term_count( $this->term_taxonomy_id, 'language' ); // Posts count.
437 - wp_update_term_count( $this->tl_term_taxonomy_id, 'term_language' ); // Terms count.
230 + wp_update_term_count( $this->term_taxonomy_id, 'language' ); // posts count
231 + wp_update_term_count( $this->tl_term_taxonomy_id, 'term_language' ); // terms count
438 232 }
439 233
440 234 /**
441 - * Set home_url and search_url properties.
235 + * Set home_url and search_url properties
442 236 *
443 237 * @since 1.3
444 238 *
445 - * @param string $search_url Home url to use in search forms.
446 - * @param string $home_url Home url.
447 - * @return void
239 + * @param string $search_url
240 + * @param string $home_url
448 241 */
449 242 public function set_home_url( $search_url, $home_url ) {
450 243 $this->search_url = $search_url;
451 244 $this->home_url = $home_url;
@@ -451,34 +244,25 @@
451 244 $this->home_url = $home_url;
452 245 }
453 246
454 247 /**
455 - * Sets the scheme of the home url and the flag urls.
248 + * Set home_url scheme
249 + * this can't be cached across pages
456 250 *
457 - * This can't be cached across pages.
458 - *
459 - * @since 2.8
460 - *
461 - * @return void
251 + * @since 1.6.4
462 252 */
463 - public function set_url_scheme() {
253 + public function set_home_url_scheme() {
464 254 $this->home_url = set_url_scheme( $this->home_url );
465 255 $this->search_url = set_url_scheme( $this->search_url );
466 -
467 - // Set url scheme, also for the flags.
468 - $this->flag_url = set_url_scheme( $this->flag_url );
469 - if ( ! empty( $this->custom_flag_url ) ) {
470 - $this->custom_flag_url = set_url_scheme( $this->custom_flag_url );
471 - }
472 256 }
473 257
474 258 /**
475 - * Returns the language locale.
476 - * Converts WP locales to W3C valid locales for display.
259 + * Returns the language locale
260 + * Converts WP locales to W3C valid locales for display
477 261 *
478 262 * @since 1.8
479 263 *
480 - * @param string $filter Either 'display' or 'raw', defaults to raw.
264 + * @param string $filter either 'display' or 'raw', defaults to raw
481 265 * @return string
482 266 */
483 267 public function get_locale( $filter = 'raw' ) {
484 268 return 'display' === $filter ? $this->w3c : $this->locale;