PluginProbe
Polylang / 1.5
Polylang v1.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/api.php +123 -260 2.71.5 View file →
@@ -1,23 +1,22 @@
1 1 <?php
2 2
3 -/**
4 - * Template tag: displays the language switcher
3 +/*
4 + * template tag: displays the language switcher
5 5 *
6 - * List of parameters accepted in $args:
6 + * list of parameters accepted in $args:
7 7 *
8 8 * dropdown => displays a dropdown if set to 1, defaults to 0
9 - * echo => echoes the switcher if set to 1 ( default )
10 - * hide_if_empty => hides languages with no posts ( or pages ) if set to 1 ( default )
9 + * echo => echoes the the switcher if set to 1 (default)
10 + * hide_if_empty => hides languages with no posts (or pages) if set to 1 (default)
11 11 * show_flags => shows flags if set to 1, defaults to 0
12 - * show_names => shows languages names if set to 1 ( default )
13 - * display_names_as => whether to display the language name or its slug, valid options are 'slug' and 'name', defaults to name
12 + * show_names => shows languages names if set to 1 (default)
13 + * display_names_as => wether to display the language name or code. valid options are 'slug' and 'name'
14 14 * force_home => forces linking to the home page is set to 1, defaults to 0
15 15 * hide_if_no_translation => hides the link if there is no translation if set to 1, defaults to 0
16 16 * hide_current => hides the current language if set to 1, defaults to 0
17 17 * post_id => if not null, link to translations of post defined by post_id, defaults to null
18 18 * raw => set this to true to build your own custom language switcher, defaults to 0
19 - * item_spacing => whether to preserve or discard whitespace between list items, valid options are 'preserve' and 'discard', defaults to preserve
20 19 *
21 20 * @since 0.5
22 21 *
23 22 * @param array $args optional
@@ -22,113 +21,106 @@
22 21 *
23 22 * @param array $args optional
24 23 * @return null|string|array null if displaying, array if raw is requested, string otherwise
25 24 */
26 -function pll_the_languages( $args = '' ) {
27 - if ( PLL() instanceof PLL_Frontend ) {
28 - $switcher = new PLL_Switcher();
29 - return $switcher->the_languages( PLL()->links, $args );
25 +function pll_the_languages($args = '') {
26 + global $polylang;
27 + if ($polylang instanceof PLL_Frontend && !empty($polylang->links)) {
28 + $switcher = new PLL_Switcher;
29 + return $switcher->the_languages($polylang->links, $args);
30 30 }
31 31 return '';
32 32 }
33 33
34 -/**
35 - * Returns the current language on frontend
36 - * Returns the language set in admin language filter on backend ( false if set to all languages )
34 +/*
35 + * returns the current language
37 36 *
38 37 * @since 0.8.1
39 38 *
40 - * @param string $field Optional, the language field to return ( see PLL_Language ), defaults to 'slug', pass OBJECT constant to get the language object.
41 - * @return string|PLL_Language|bool The requested field for the current language
39 + * @param string $field optional the language field to return 'name', 'locale', defaults to 'slug'
40 + * @return string the requested field for the current language
42 41 */
43 -function pll_current_language( $field = 'slug' ) {
44 - if ( OBJECT === $field ) {
45 - return PLL()->curlang;
46 - }
47 - return isset( PLL()->curlang->$field ) ? PLL()->curlang->$field : false;
42 +function pll_current_language($field = 'slug') {
43 + global $polylang;
44 + return isset($polylang->curlang->$field) ? $polylang->curlang->$field : false;
48 45 }
49 46
50 -/**
51 - * Returns the default language
47 +/*
48 + * returns the default language
52 49 *
53 50 * @since 1.0
54 51 *
55 - * @param string $field Optional, the language field to return ( see PLL_Language ), defaults to 'slug', pass OBJECT constant to get the language object.
56 - * @return string|PLL_Language|bool The requested field for the default language
52 + * @param string $field optional the language field to return 'name', 'locale', defaults to 'slug'
53 + * @return string the requested field for the default language
57 54 */
58 -function pll_default_language( $field = 'slug' ) {
59 - if ( isset( PLL()->options['default_lang'] ) ) {
60 - $lang = PLL()->model->get_language( PLL()->options['default_lang'] );
61 - if ( $lang ) {
62 - if ( OBJECT === $field ) {
63 - return $lang;
64 - }
65 - return isset( $lang->$field ) ? $lang->$field : false;
66 - }
67 - }
68 - return false;
55 +function pll_default_language($field = 'slug') {
56 + global $polylang;
57 + return isset($polylang->options['default_lang']) && ($lang = $polylang->model->get_language($polylang->options['default_lang'])) && isset($lang->$field) ? $lang->$field : false;
69 58 }
70 59
71 -/**
72 - * Among the post and its translations, returns the id of the post which is in the language represented by $slug
60 +/*
61 + * among the post and its translations, returns the id of the post which is in the language represented by $slug
73 62 *
74 63 * @since 0.5
75 64 *
76 - * @param int $post_id post id
77 - * @param string $slug optional language code, defaults to current language
78 - * @return int|false|null post id of the translation if exists, false otherwise, null if the current language is not defined yet
65 + * @param int $post_id post id
66 + * @param string $slug optional language code, defaults to current language
67 + * @return int post id of the translation if exists
79 68 */
80 -function pll_get_post( $post_id, $slug = '' ) {
81 - return ( $slug = $slug ? $slug : pll_current_language() ) ? PLL()->model->post->get( $post_id, $slug ) : null;
69 +function pll_get_post($post_id, $slug = '') {
70 + global $polylang;
71 + return isset($polylang) && ($slug = $slug ? $slug : pll_current_language()) ? $polylang->model->get_post($post_id, $slug) : null;
82 72 }
83 73
84 -/**
85 - * Among the term and its translations, returns the id of the term which is in the language represented by $slug
74 +/*
75 + * among the term and its translations, returns the id of the term which is in the language represented by $slug
86 76 *
87 77 * @since 0.5
88 78 *
89 - * @param int $term_id term id
90 - * @param string $slug optional language code, defaults to current language
91 - * @return int|false|null term id of the translation if exists, false otherwise, null if the current language is not defined yet
79 + * @param int $term_id term id
80 + * @param string $slug optional language code, defaults to current language
81 + * @return int term id of the translation if exists
92 82 */
93 -function pll_get_term( $term_id, $slug = '' ) {
94 - return ( $slug = $slug ? $slug : pll_current_language() ) ? PLL()->model->term->get( $term_id, $slug ) : null;
83 +function pll_get_term($term_id, $slug = '') {
84 + global $polylang;
85 + return isset($polylang) && ($slug = $slug ? $slug : pll_current_language()) ? $polylang->model->get_term($term_id, $slug) : null;
95 86 }
96 87
97 -/**
98 - * Returns the home url in the current language
88 +/*
89 + * returns the home url in the current language
99 90 *
100 91 * @since 0.8
101 92 *
102 - * @param string $lang language code ( optional on frontend )
93 + * @param string $lang language code (optional on frontend)
103 94 * @return string
104 95 */
105 -function pll_home_url( $lang = '' ) {
106 - if ( empty( $lang ) ) {
96 +function pll_home_url($lang = '') {
97 + global $polylang;
98 +
99 + if (empty($lang))
107 100 $lang = pll_current_language();
108 - }
109 101
110 - return empty( $lang ) ? home_url( '/' ) : PLL()->links->get_home_url( $lang );
102 + return isset($polylang) && !empty($polylang->links) && !empty($lang) ? $polylang->links->get_home_url($lang) : home_url('/');
111 103 }
112 104
113 -/**
114 - * Registers a string for translation in the "strings translation" panel
105 +/*
106 + * registers a string for translation in the "strings translation" panel
115 107 *
116 108 * @since 0.6
117 109 *
118 - * @param string $name a unique name for the string
119 - * @param string $string the string to register
120 - * @param string $context optional the group in which the string is registered, defaults to 'polylang'
121 - * @param bool $multiline optional whether the string table should display a multiline textarea or a single line input, defaults to single line
110 + * @param string $name a unique name for the string
111 + * @param string $string the string to register
112 + * @param string $context optional the group in which the string is registered, defaults to 'polylang'
113 + * @param bool $multiline optional wether the string table should display a multiline textarea or a single line input, defaults to single line
122 114 */
123 -function pll_register_string( $name, $string, $context = 'polylang', $multiline = false ) {
124 - if ( PLL() instanceof PLL_Admin_Base ) {
125 - PLL_Admin_Strings::register_string( $name, $string, $context, $multiline );
126 - }
115 +function pll_register_string($name, $string, $context = 'polylang', $multiline = false) {
116 + global $polylang;
117 + if ($polylang instanceof PLL_Admin && !empty($polylang->settings_page))
118 + $polylang->settings_page->register_string($name, $string, $context, $multiline);
127 119 }
128 120
129 -/**
130 - * Translates a string ( previously registered with pll_register_string )
121 +/*
122 + * translates a string (previously registered with pll_register_string)
131 123 *
132 124 * @since 0.6
133 125 *
134 126 * @param string $string the string to translate
@@ -133,134 +125,56 @@
133 125 *
134 126 * @param string $string the string to translate
135 127 * @return string the string translation in the current language
136 128 */
137 -function pll__( $string ) {
138 - return is_scalar( $string ) ? __( $string, 'pll_string' ) : $string; // PHPCS:ignore WordPress.WP.I18n
129 +function pll__($string) {
130 + return __($string, 'pll_string');
139 131 }
140 132
141 -/**
142 - * Translates a string ( previously registered with pll_register_string ) and escapes it for safe use in HTML output.
133 +/*
134 + * echoes a translated string (previously registered with pll_register_string)
143 135 *
144 - * @since 2.1
145 - *
146 - * @param string $string the string to translate
147 - * @return string translation in the current language
148 - */
149 -function pll_esc_html__( $string ) {
150 - return esc_html( pll__( $string ) );
151 -}
152 -
153 -/**
154 - * Translates a string ( previously registered with pll_register_string ) and escapes it for safe use in HTML attributes.
155 - *
156 - * @since 2.1
157 - *
158 - * @param string $string The string to translate
159 - * @return string
160 - */
161 -function pll_esc_attr__( $string ) {
162 - return esc_attr( pll__( $string ) );
163 -}
164 -
165 -/**
166 - * Echoes a translated string ( previously registered with pll_register_string )
167 - * It is an equivalent of _e() and is not escaped.
168 - *
169 136 * @since 0.6
170 137 *
171 - * @param string $string The string to translate
172 - */
173 -function pll_e( $string ) {
174 - echo pll__( $string ); // phpcs:ignore
175 -}
176 -
177 -/**
178 - * Echoes a translated string ( previously registered with pll_register_string ) and escapes it for safe use in HTML output.
179 - *
180 - * @since 2.1
181 - *
182 - * @param string $string The string to translate
183 - */
184 -function pll_esc_html_e( $string ) {
185 - echo pll_esc_html__( $string ); // phpcs:ignore WordPress.Security.EscapeOutput
186 -}
187 -
188 -/**
189 - * Echoes a translated a string ( previously registered with pll_register_string ) and escapes it for safe use in HTML attributes.
190 - *
191 - * @since 2.1
192 - *
193 - * @param string $string The string to translate
194 - */
195 -function pll_esc_attr_e( $string ) {
196 - echo pll_esc_attr__( $string ); // phpcs:ignore WordPress.Security.EscapeOutput
197 -}
198 -
199 -/**
200 - * Translates a string ( previously registered with pll_register_string )
201 - *
202 - * @since 1.5.4
203 - *
204 138 * @param string $string the string to translate
205 - * @param string $lang language code
206 - * @return string the string translation in the requested language
207 139 */
208 -function pll_translate_string( $string, $lang ) {
209 - if ( PLL() instanceof PLL_Frontend && pll_current_language() == $lang ) {
210 - return pll__( $string );
211 - }
212 -
213 - if ( ! is_scalar( $string ) ) {
214 - return $string;
215 - }
216 -
217 - static $cache; // Cache object to avoid loading the same translations object several times
218 -
219 - if ( empty( $cache ) ) {
220 - $cache = new PLL_Cache();
221 - }
222 -
223 - if ( false === $mo = $cache->get( $lang ) ) {
224 - $mo = new PLL_MO();
225 - $mo->import_from_db( PLL()->model->get_language( $lang ) );
226 - $cache->set( $lang, $mo );
227 - }
228 -
229 - return $mo->translate( $string );
140 +function pll_e($string) {
141 + _e($string, 'pll_string');
230 142 }
231 143
232 -/**
233 - * Returns true if Polylang manages languages and translations for this post type
144 +/*
145 + * returns true if Polylang manages languages and translations for this post type
234 146 *
235 147 * @since 1.0.1
236 148 *
237 - * @param string $post_type Post type name
149 + * @param string post type name
238 150 * @return bool
239 151 */
240 -function pll_is_translated_post_type( $post_type ) {
241 - return PLL()->model->is_translated_post_type( $post_type );
152 +function pll_is_translated_post_type($post_type) {
153 + global $polylang;
154 + return isset($polylang) && $polylang->model->is_translated_post_type($post_type);
242 155 }
243 156
244 -/**
245 - * Returns true if Polylang manages languages and translations for this taxonomy
157 +/*
158 + * returns true if Polylang manages languages and translations for this taxonomy
246 159 *
247 160 * @since 1.0.1
248 161 *
249 - * @param string $tax Taxonomy name
162 + * @param string taxonomy name
250 163 * @return bool
251 164 */
252 -function pll_is_translated_taxonomy( $tax ) {
253 - return PLL()->model->is_translated_taxonomy( $tax );
165 +function pll_is_translated_taxonomy($tax) {
166 + global $polylang;
167 + return isset($polylang) && $polylang->model->is_translated_taxonomy($tax);
254 168 }
255 169
256 -/**
257 - * Returns the list of available languages
170 +/*
171 + * returns the list of available languages
258 172 *
259 - * List of parameters accepted in $args:
173 + * list of parameters accepted in $args:
260 174 *
261 - * hide_empty => hides languages with no posts if set to true ( defaults to false )
262 - * fields => return only that field if set ( see PLL_Language for a list of fields )
175 + * hide_empty => hides languages with no posts if set to true (defaults to false)
176 + * fields => return only that field if set (see PLL_Language for a list of fields)
263 177 *
264 178 * @since 1.5
265 179 *
266 180 * @param array $args list of parameters
@@ -265,128 +179,77 @@
265 179 *
266 180 * @param array $args list of parameters
267 181 * @return array
268 182 */
269 -function pll_languages_list( $args = array() ) {
270 - $args = wp_parse_args( $args, array( 'fields' => 'slug' ) );
271 - return PLL()->model->get_languages_list( $args );
183 +function pll_languages_list($args = array()) {
184 + global $polylang;
185 + $args = wp_parse_args($args, array('fields' => 'slug'));
186 + return isset($polylang) ? $polylang->model->get_languages_list($args) : false;
272 187 }
273 188
274 -/**
275 - * Set the post language
189 +/*
190 + * set the post language
276 191 *
277 192 * @since 1.5
278 193 *
279 - * @param int $id post id
194 + * @param int $post_id post id
280 195 * @param string $lang language code
281 196 */
282 -function pll_set_post_language( $id, $lang ) {
283 - PLL()->model->post->set_language( $id, $lang );
197 +function pll_set_post_language($id, $lang) {
198 + global $polylang;
199 + if (isset($polylang))
200 + $polylang->model->set_post_language($id, $lang);
284 201 }
285 202
286 -/**
287 - * Set the term language
203 +/*
204 + * set the term language
288 205 *
289 206 * @since 1.5
290 207 *
291 - * @param int $id term id
208 + * @param int $id term id
292 209 * @param string $lang language code
293 210 */
294 -function pll_set_term_language( $id, $lang ) {
295 - PLL()->model->term->set_language( $id, $lang );
211 +function pll_set_term_language($id, $lang) {
212 + global $polylang;
213 + if (isset($polylang))
214 + $polylang->model->set_term_language($id, $lang);
296 215 }
297 216
298 -/**
299 - * Save posts translations
217 +/*
218 + * save posts translations
300 219 *
301 220 * @since 1.5
302 221 *
303 222 * @param array $arr an associative array of translations with language code as key and post id as value
304 223 */
305 -function pll_save_post_translations( $arr ) {
306 - PLL()->model->post->save_translations( reset( $arr ), $arr );
224 +function pll_save_post_translations($arr) {
225 + global $polylang;
226 + if (isset($polylang))
227 + $polylang->model->save_translations('post', reset($arr), $arr);
307 228 }
308 229
309 -/**
310 - * Save terms translations
230 +/*
231 + * save terms translations
311 232 *
312 233 * @since 1.5
313 234 *
314 235 * @param array $arr an associative array of translations with language code as key and term id as value
315 236 */
316 -function pll_save_term_translations( $arr ) {
317 - PLL()->model->term->save_translations( reset( $arr ), $arr );
237 +function pll_save_term_translations($arr) {
238 + global $polylang;
239 + if (isset($polylang))
240 + $polylang->model->save_translations('term', reset($arr), $arr);
318 241 }
319 242
320 -/**
321 - * Returns the post language
243 +/*
244 + * count posts in a language
322 245 *
323 - * @since 1.5.4
324 - *
325 - * @param int $post_id
326 - * @param string $field Optional, the language field to return ( see PLL_Language ), defaults to 'slug'
327 - * @return bool|string The requested field for the post language, false if no language is associated to that post
328 - */
329 -function pll_get_post_language( $post_id, $field = 'slug' ) {
330 - return ( $lang = PLL()->model->post->get_language( $post_id ) ) ? $lang->$field : false;
331 -}
332 -
333 -/**
334 - * Returns the term language
335 - *
336 - * @since 1.5.4
337 - *
338 - * @param int $term_id
339 - * @param string $field Optional, the language field to return ( see PLL_Language ), defaults to 'slug'
340 - * @return bool|string The requested field for the term language, false if no language is associated to that term
341 - */
342 -function pll_get_term_language( $term_id, $field = 'slug' ) {
343 - return ( $lang = PLL()->model->term->get_language( $term_id ) ) ? $lang->$field : false;
344 -}
345 -
346 -/**
347 - * Returns an array of translations of a post
348 - *
349 - * @since 1.8
350 - *
351 - * @param int $post_id
352 - * @return array an associative array of translations with language code as key and translation post_id as value
353 - */
354 -function pll_get_post_translations( $post_id ) {
355 - return PLL()->model->post->get_translations( $post_id );
356 -}
357 -
358 -/**
359 - * Returns an array of translations of a term
360 - *
361 - * @since 1.8
362 - *
363 - * @param int $term_id
364 - * @return array an associative array of translations with language code as key and translation term_id as value
365 - */
366 -function pll_get_term_translations( $term_id ) {
367 - return PLL()->model->term->get_translations( $term_id );
368 -}
369 -
370 -/**
371 - * Count posts in a language
372 - *
373 246 * @since 1.5
374 247 *
375 - * @param string $lang Language code.
376 - * @param array $args WP_Query arguments ( accepted keys: post_type, m, year, monthnum, day, author, author_name, post_format, post_status ).
377 - * @return int Posts count.
248 + * @param string $lang language code
249 + * @param array $args (accepted keys: post_type, m, year, monthnum, day, author, author_name, post_format)
250 + * @return int posts count
378 251 */
379 -function pll_count_posts( $lang, $args = array() ) {
380 - return PLL()->model->count_posts( PLL()->model->get_language( $lang ), $args );
381 -}
382 -
383 -/**
384 - * Allows to access the Polylang instance
385 - * It is always preferable to use API functions
386 - * Internal methods may be changed without prior notice
387 - *
388 - * @since 1.8
389 - */
390 -function PLL() { // PHPCS:ignore WordPress.NamingConventions.ValidFunctionName
391 - return $GLOBALS['polylang'];
252 +function pll_count_posts($lang, $args) {
253 + global $polylang;
254 + return isset($polylang) ? $polylang->model->count_posts($polylang->model->get_language($lang)) : false;
392 255 }