| @@ -8,29 +8,53 @@ | ||
| 8 | 8 | * |
| 9 | 9 | * @since 1.2 |
| 10 | 10 | */ |
| 11 | 11 | class PLL_Model { |
| 12 | - public $cache; // Our internal non persistent cache object | |
| 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 | + */ | |
| 13 | 24 | public $options; |
| 14 | - public $post, $term; // Translated objects models | |
| 15 | 25 | |
| 16 | 26 | /** |
| 17 | - * Constructor | |
| 18 | - * setups translated objects sub models | |
| 19 | - * setups filters and actions | |
| 27 | + * Translated post model. | |
| 20 | 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 | + * | |
| 21 | 45 | * @since 1.2 |
| 22 | 46 | * |
| 23 | - * @param array $options Polylang options | |
| 47 | + * @param array $options Polylang options. | |
| 24 | 48 | */ |
| 25 | 49 | public function __construct( &$options ) { |
| 26 | 50 | $this->options = &$options; |
| 27 | 51 | |
| 28 | 52 | $this->cache = new PLL_Cache(); |
| 29 | - $this->post = new PLL_Translated_Post( $this ); // translated post sub model | |
| 30 | - $this->term = new PLL_Translated_Term( $this ); // translated term sub model | |
| 53 | + $this->post = new PLL_Translated_Post( $this ); // Translated post sub model. | |
| 54 | + $this->term = new PLL_Translated_Term( $this ); // Translated term sub model. | |
| 31 | 55 | |
| 32 | - // We need to clean languages cache when editing a language and when modifying the permalink structure | |
| 56 | + // We need to clean languages cache when editing a language and when modifying the permalink structure. | |
| 33 | 57 | add_action( 'edited_term_taxonomy', array( $this, 'clean_languages_cache' ), 10, 2 ); |
| 34 | 58 | add_action( 'update_option_permalink_structure', array( $this, 'clean_languages_cache' ) ); |
| 35 | 59 | add_action( 'update_option_siteurl', array( $this, 'clean_languages_cache' ) ); |
| 36 | 60 | add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) ); |
| @@ -36,31 +60,29 @@ | ||
| 36 | 60 | add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) ); |
| 37 | 61 | |
| 38 | 62 | add_filter( 'get_terms_args', array( $this, 'get_terms_args' ) ); |
| 39 | 63 | |
| 40 | - // Just in case someone would like to display the language description ;- ) | |
| 64 | + // Just in case someone would like to display the language description ;). | |
| 41 | 65 | add_filter( 'language_description', '__return_empty_string' ); |
| 42 | 66 | } |
| 43 | 67 | |
| 44 | 68 | /** |
| 45 | - * Returns the list of available languages | |
| 46 | - * caches the list in a db transient ( except flags ), unless PLL_CACHE_LANGUAGES is set to false | |
| 47 | - * caches the list ( with flags ) in the private property $languages | |
| 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. | |
| 48 | 72 | * |
| 49 | - * List of parameters accepted in $args: | |
| 50 | - * | |
| 51 | - * hide_empty => hides languages with no posts if set to true ( defaults to false ) | |
| 52 | - * fields => return only that field if set ( see PLL_Language for a list of fields ) | |
| 53 | - * | |
| 54 | 73 | * @since 0.1 |
| 55 | 74 | * |
| 56 | - * @param array $args | |
| 57 | - * @return array|string|int list of PLL_Language objects or PLL_Language object properties | |
| 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. | |
| 58 | 80 | */ |
| 59 | 81 | public function get_languages_list( $args = array() ) { |
| 60 | 82 | if ( false === $languages = $this->cache->get( 'languages' ) ) { |
| 61 | 83 | |
| 62 | - // Create the languages from taxonomies | |
| 84 | + // Create the languages from taxonomies. | |
| 63 | 85 | if ( ( defined( 'PLL_CACHE_LANGUAGES' ) && ! PLL_CACHE_LANGUAGES ) || false === ( $languages = get_transient( 'pll_languages_list' ) ) ) { |
| 64 | 86 | $languages = get_terms( 'language', array( 'hide_empty' => false, 'orderby' => 'term_group' ) ); |
| 65 | 87 | $languages = empty( $languages ) || is_wp_error( $languages ) ? array() : $languages; |
| 66 | 88 | |
| @@ -68,38 +90,40 @@ | ||
| 68 | 90 | $term_languages = empty( $term_languages ) || is_wp_error( $term_languages ) ? |
| 69 | 91 | array() : array_combine( wp_list_pluck( $term_languages, 'slug' ), $term_languages ); |
| 70 | 92 | |
| 71 | 93 | if ( ! empty( $languages ) && ! empty( $term_languages ) ) { |
| 72 | - // Don't use array_map + create_function to instantiate an autoloaded class as it breaks badly in old versions of PHP | |
| 94 | + // Don't use array_map + create_function() to instantiate an autoloaded class as it breaks badly in old versions of PHP. | |
| 73 | 95 | foreach ( $languages as $k => $v ) { |
| 74 | 96 | $languages[ $k ] = new PLL_Language( $v, $term_languages[ 'pll_' . $v->slug ] ); |
| 75 | 97 | } |
| 76 | 98 | |
| 77 | - // We will need the languages list to allow its access in the filter below | |
| 99 | + // We will need the languages list to allow its access in the filter below. | |
| 78 | 100 | $this->cache->set( 'languages', $languages ); |
| 79 | 101 | |
| 80 | 102 | /** |
| 81 | - * Filter the list of languages *before* it is stored in the persistent cache | |
| 82 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 103 | + * Filters the list of languages *before* it is stored in the persistent cache. | |
| 104 | + * /!\ This filter is fired *before* the $polylang object is available. | |
| 83 | 105 | * |
| 84 | 106 | * @since 1.7.5 |
| 85 | 107 | * |
| 86 | - * @param array $languages the list of language objects | |
| 87 | - * @param object $model PLL_Model object | |
| 108 | + * @param PLL_Language[] $languages The list of language objects. | |
| 109 | + * @param PLL_Model $model PLL_Model object. | |
| 88 | 110 | */ |
| 89 | 111 | $languages = apply_filters( 'pll_languages_list', $languages, $this ); |
| 90 | 112 | |
| 91 | - // Don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache | |
| 92 | - // Thanks to captin411 for catching this! | |
| 93 | - // See https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255; | |
| 113 | + /* | |
| 114 | + * Don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache. | |
| 115 | + * Thanks to captin411 for catching this! | |
| 116 | + * @see https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255 | |
| 117 | + */ | |
| 94 | 118 | set_transient( 'pll_languages_list', array_map( 'get_object_vars', $languages ) ); |
| 95 | 119 | } |
| 96 | 120 | else { |
| 97 | - $languages = array(); // In case something went wrong | |
| 121 | + $languages = array(); // In case something went wrong. | |
| 98 | 122 | } |
| 99 | 123 | } |
| 100 | 124 | |
| 101 | - // Create the languages directly from arrays stored in transients | |
| 125 | + // Create the languages directly from arrays stored in transients. | |
| 102 | 126 | else { |
| 103 | 127 | foreach ( $languages as $k => $v ) { |
| 104 | 128 | $languages[ $k ] = new PLL_Language( $v ); |
| 105 | 129 | } |
| @@ -105,14 +129,14 @@ | ||
| 105 | 129 | } |
| 106 | 130 | } |
| 107 | 131 | |
| 108 | 132 | /** |
| 109 | - * Filter the list of languages *after* it is stored in the persistent cache | |
| 110 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 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. | |
| 111 | 135 | * |
| 112 | 136 | * @since 1.8 |
| 113 | 137 | * |
| 114 | - * @param array $languages the list of language objects | |
| 138 | + * @param PLL_Language[] $languages The list of language objects. | |
| 115 | 139 | */ |
| 116 | 140 | $languages = apply_filters( 'pll_after_languages_cache', $languages ); |
| 117 | 141 | $this->cache->set( 'languages', $languages ); |
| 118 | 142 | } |
| @@ -118,9 +142,9 @@ | ||
| 118 | 142 | } |
| 119 | 143 | |
| 120 | 144 | $args = wp_parse_args( $args, array( 'hide_empty' => false ) ); |
| 121 | 145 | |
| 122 | - // Remove empty languages if requested | |
| 146 | + // Remove empty languages if requested. | |
| 123 | 147 | if ( $args['hide_empty'] ) { |
| 124 | 148 | $languages = wp_list_filter( $languages, array( 'count' => 0 ), 'NOT' ); |
| 125 | 149 | } |
| 126 | 150 | |
| @@ -135,8 +159,9 @@ | ||
| 135 | 159 | * @since 1.2 |
| 136 | 160 | * |
| 137 | 161 | * @param int $term not used |
| 138 | 162 | * @param string $taxonomy taxonomy name |
| 163 | + * @return void | |
| 139 | 164 | */ |
| 140 | 165 | public function clean_languages_cache( $term = 0, $taxonomy = null ) { |
| 141 | 166 | if ( empty( $taxonomy ) || 'language' == $taxonomy ) { |
| 142 | 167 | delete_transient( 'pll_languages_list' ); |
| @@ -159,14 +184,14 @@ | ||
| 159 | 184 | return $args; |
| 160 | 185 | } |
| 161 | 186 | |
| 162 | 187 | /** |
| 163 | - * Returns the language by its term_id, tl_term_id, slug or locale | |
| 188 | + * Returns the language by its term_id, tl_term_id, slug or locale. | |
| 164 | 189 | * |
| 165 | 190 | * @since 0.1 |
| 166 | 191 | * |
| 167 | - * @param int|string $value term_id, tl_term_id, slug or locale of the queried language | |
| 168 | - * @return object|bool PLL_Language object, false if no language found | |
| 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. | |
| 169 | 194 | */ |
| 170 | 195 | public function get_language( $value ) { |
| 171 | 196 | if ( is_object( $value ) ) { |
| 172 | 197 | return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // will force cast to PLL_Language |
| @@ -186,15 +211,15 @@ | ||
| 186 | 211 | return $return; |
| 187 | 212 | } |
| 188 | 213 | |
| 189 | 214 | /** |
| 190 | - * Adds terms clauses to get_terms to filter them by languages - used in both frontend and admin | |
| 215 | + * Adds terms clauses to the term query to filter them by languages. | |
| 191 | 216 | * |
| 192 | 217 | * @since 1.2 |
| 193 | 218 | * |
| 194 | - * @param array $clauses the list of sql clauses in terms query | |
| 195 | - * @param object $lang PLL_Language object | |
| 196 | - * @return array modified list of clauses | |
| 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. | |
| 197 | 222 | */ |
| 198 | 223 | public function terms_clauses( $clauses, $lang ) { |
| 199 | 224 | if ( ! empty( $lang ) && false === strpos( $clauses['join'], 'pll_tr' ) ) { |
| 200 | 225 | $clauses['join'] .= $this->term->join_clause(); |
| @@ -203,16 +228,17 @@ | ||
| 203 | 228 | return $clauses; |
| 204 | 229 | } |
| 205 | 230 | |
| 206 | 231 | /** |
| 207 | - * Returns post types that need to be translated | |
| 208 | - * the post types list is cached for better better performance | |
| 209 | - * wait for 'after_setup_theme' to apply the cache to allow themes adding the filter in functions.php | |
| 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. | |
| 210 | 236 | * |
| 211 | 237 | * @since 1.2 |
| 212 | 238 | * |
| 213 | - * @param bool $filter true if we should return only valid registered post types | |
| 214 | - * @return array post type names for which Polylang manages languages and translations | |
| 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. | |
| 215 | 241 | */ |
| 216 | 242 | public function get_translated_post_types( $filter = true ) { |
| 217 | 243 | if ( false === $post_types = $this->cache->get( 'post_types' ) ) { |
| 218 | 244 | $post_types = array( 'post' => 'post', 'page' => 'page', 'wp_block' => 'wp_block' ); |
| @@ -225,9 +251,9 @@ | ||
| 225 | 251 | $post_types = array_merge( $post_types, array_combine( $this->options['post_types'], $this->options['post_types'] ) ); |
| 226 | 252 | } |
| 227 | 253 | |
| 228 | 254 | /** |
| 229 | - * Filter the list of post types available for translation. | |
| 255 | + * Filters the list of post types available for translation. | |
| 230 | 256 | * The default are post types which have the parameter ‘public’ set to true. |
| 231 | 257 | * The filter must be added soon in the WordPress loading process: |
| 232 | 258 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 233 | 259 | * |
| @@ -232,10 +258,10 @@ | ||
| 232 | 258 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 233 | 259 | * |
| 234 | 260 | * @since 0.8 |
| 235 | 261 | * |
| 236 | - * @param array $post_types list of post type names | |
| 237 | - * @param bool $is_settings true when displaying the list of custom post types in Polylang settings | |
| 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. | |
| 238 | 264 | */ |
| 239 | 265 | $post_types = apply_filters( 'pll_get_post_types', $post_types, false ); |
| 240 | 266 | |
| 241 | 267 | if ( did_action( 'after_setup_theme' ) ) { |
| @@ -246,13 +272,13 @@ | ||
| 246 | 272 | return $filter ? array_intersect( $post_types, get_post_types() ) : $post_types; |
| 247 | 273 | } |
| 248 | 274 | |
| 249 | 275 | /** |
| 250 | - * Returns true if Polylang manages languages and translations for this post type | |
| 276 | + * Returns true if Polylang manages languages and translations for this post type. | |
| 251 | 277 | * |
| 252 | 278 | * @since 1.2 |
| 253 | 279 | * |
| 254 | - * @param string|array $post_type post type name or array of post type names | |
| 280 | + * @param string|string[] $post_type Post type name or array of post type names. | |
| 255 | 281 | * @return bool |
| 256 | 282 | */ |
| 257 | 283 | public function is_translated_post_type( $post_type ) { |
| 258 | 284 | $post_types = $this->get_translated_post_types( false ); |
| @@ -259,14 +285,14 @@ | ||
| 259 | 285 | return ( is_array( $post_type ) && array_intersect( $post_type, $post_types ) || in_array( $post_type, $post_types ) || 'any' === $post_type && ! empty( $post_types ) ); |
| 260 | 286 | } |
| 261 | 287 | |
| 262 | 288 | /** |
| 263 | - * Return taxonomies that need to be translated | |
| 289 | + * Returns taxonomies that need to be translated. | |
| 264 | 290 | * |
| 265 | 291 | * @since 1.2 |
| 266 | 292 | * |
| 267 | - * @param bool $filter true if we should return only valid registered taxonomies | |
| 268 | - * @return array array of registered taxonomy names for which Polylang manages languages and translations | |
| 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. | |
| 269 | 295 | */ |
| 270 | 296 | public function get_translated_taxonomies( $filter = true ) { |
| 271 | 297 | if ( false === $taxonomies = $this->cache->get( 'taxonomies' ) ) { |
| 272 | 298 | $taxonomies = array( 'category' => 'category', 'post_tag' => 'post_tag' ); |
| @@ -275,9 +301,9 @@ | ||
| 275 | 301 | $taxonomies = array_merge( $taxonomies, array_combine( $this->options['taxonomies'], $this->options['taxonomies'] ) ); |
| 276 | 302 | } |
| 277 | 303 | |
| 278 | 304 | /** |
| 279 | - * Filter the list of taxonomies available for translation. | |
| 305 | + * Filters the list of taxonomies available for translation. | |
| 280 | 306 | * The default are taxonomies which have the parameter ‘public’ set to true. |
| 281 | 307 | * The filter must be added soon in the WordPress loading process: |
| 282 | 308 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 283 | 309 | * |
| @@ -282,10 +308,10 @@ | ||
| 282 | 308 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 283 | 309 | * |
| 284 | 310 | * @since 0.8 |
| 285 | 311 | * |
| 286 | - * @param array $taxonomies list of taxonomy names | |
| 287 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 312 | + * @param string[] $taxonomies List of taxonomy names. | |
| 313 | + * @param bool $is_settings True when displaying the list of custom taxonomies in Polylang settings. | |
| 288 | 314 | */ |
| 289 | 315 | $taxonomies = apply_filters( 'pll_get_taxonomies', $taxonomies, false ); |
| 290 | 316 | if ( did_action( 'after_setup_theme' ) ) { |
| 291 | 317 | $this->cache->set( 'taxonomies', $taxonomies ); |
| @@ -295,13 +321,13 @@ | ||
| 295 | 321 | return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; |
| 296 | 322 | } |
| 297 | 323 | |
| 298 | 324 | /** |
| 299 | - * Returns true if Polylang manages languages and translations for this taxonomy | |
| 325 | + * Returns true if Polylang manages languages and translations for this taxonomy. | |
| 300 | 326 | * |
| 301 | 327 | * @since 1.2 |
| 302 | 328 | * |
| 303 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 329 | + * @param string|string[] $tax Taxonomy name or array of taxonomy names. | |
| 304 | 330 | * @return bool |
| 305 | 331 | */ |
| 306 | 332 | public function is_translated_taxonomy( $tax ) { |
| 307 | 333 | $taxonomies = $this->get_translated_taxonomies( false ); |
| @@ -308,14 +334,14 @@ | ||
| 308 | 334 | return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); |
| 309 | 335 | } |
| 310 | 336 | |
| 311 | 337 | /** |
| 312 | - * Return taxonomies that need to be filtered ( post_format like ) | |
| 338 | + * Return staxonomies that need to be filtered ( post_format like ). | |
| 313 | 339 | * |
| 314 | 340 | * @since 1.7 |
| 315 | 341 | * |
| 316 | - * @param bool $filter true if we should return only valid registered taxonomies | |
| 317 | - * @return array array of registered taxonomy names | |
| 342 | + * @param bool $filter True if we should return only valid registered taxonomies. | |
| 343 | + * @return string[] Array of registered taxonomy names. | |
| 318 | 344 | */ |
| 319 | 345 | public function get_filtered_taxonomies( $filter = true ) { |
| 320 | 346 | if ( did_action( 'after_setup_theme' ) ) { |
| 321 | 347 | static $taxonomies = null; |
| @@ -324,9 +350,9 @@ | ||
| 324 | 350 | if ( empty( $taxonomies ) ) { |
| 325 | 351 | $taxonomies = array( 'post_format' => 'post_format' ); |
| 326 | 352 | |
| 327 | 353 | /** |
| 328 | - * Filter the list of taxonomies not translatable but filtered by language. | |
| 354 | + * Filters the list of taxonomies not translatable but filtered by language. | |
| 329 | 355 | * Includes only the post format by default |
| 330 | 356 | * The filter must be added soon in the WordPress loading process: |
| 331 | 357 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 332 | 358 | * |
| @@ -331,10 +357,10 @@ | ||
| 331 | 357 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 332 | 358 | * |
| 333 | 359 | * @since 1.7 |
| 334 | 360 | * |
| 335 | - * @param array $taxonomies list of taxonomy names | |
| 336 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 361 | + * @param string[] $taxonomies List of taxonomy names. | |
| 362 | + * @param bool $is_settings True when displaying the list of custom taxonomies in Polylang settings. | |
| 337 | 363 | */ |
| 338 | 364 | $taxonomies = apply_filters( 'pll_filtered_taxonomies', $taxonomies, false ); |
| 339 | 365 | } |
| 340 | 366 | |
| @@ -341,13 +367,13 @@ | ||
| 341 | 367 | return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; |
| 342 | 368 | } |
| 343 | 369 | |
| 344 | 370 | /** |
| 345 | - * Returns true if Polylang filters this taxonomy per language | |
| 371 | + * Returns true if Polylang filters this taxonomy per language. | |
| 346 | 372 | * |
| 347 | 373 | * @since 1.7 |
| 348 | 374 | * |
| 349 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 375 | + * @param string|string[] $tax Taxonomy name or array of taxonomy names. | |
| 350 | 376 | * @return bool |
| 351 | 377 | */ |
| 352 | 378 | public function is_filtered_taxonomy( $tax ) { |
| 353 | 379 | $taxonomies = $this->get_filtered_taxonomies( false ); |
| @@ -354,9 +380,9 @@ | ||
| 354 | 380 | return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); |
| 355 | 381 | } |
| 356 | 382 | |
| 357 | 383 | /** |
| 358 | - * Returns the query vars of all filtered taxonomies | |
| 384 | + * Returns the query vars of all filtered taxonomies. | |
| 359 | 385 | * |
| 360 | 386 | * @since 1.7 |
| 361 | 387 | * |
| 362 | 388 | * @return array |
| @@ -364,62 +390,27 @@ | ||
| 364 | 390 | public function get_filtered_taxonomies_query_vars() { |
| 365 | 391 | $query_vars = array(); |
| 366 | 392 | foreach ( $this->get_filtered_taxonomies() as $filtered_tax ) { |
| 367 | 393 | $tax = get_taxonomy( $filtered_tax ); |
| 368 | - $query_vars[] = $tax->query_var; | |
| 394 | + if ( ! empty( $tax ) ) { | |
| 395 | + $query_vars[] = $tax->query_var; | |
| 396 | + } | |
| 369 | 397 | } |
| 370 | 398 | return $query_vars; |
| 371 | 399 | } |
| 372 | 400 | |
| 373 | 401 | /** |
| 374 | - * Create a default category for a language | |
| 375 | - * | |
| 376 | - * @since 1.2 | |
| 377 | - * | |
| 378 | - * @param object|string|int $lang language | |
| 379 | - */ | |
| 380 | - public function create_default_category( $lang ) { | |
| 381 | - $lang = $this->get_language( $lang ); | |
| 382 | - | |
| 383 | - // create a new category | |
| 384 | - // FIXME this is translated in admin language when we would like it in $lang | |
| 385 | - $cat_name = __( 'Uncategorized', 'polylang' ); | |
| 386 | - $cat_slug = sanitize_title( $cat_name . '-' . $lang->slug ); | |
| 387 | - $cat = wp_insert_term( $cat_name, 'category', array( 'slug' => $cat_slug ) ); | |
| 388 | - | |
| 389 | - // check that the category was not previously created ( in case the language was deleted and recreated ) | |
| 390 | - $cat = isset( $cat->error_data['term_exists'] ) ? $cat->error_data['term_exists'] : $cat['term_id']; | |
| 391 | - | |
| 392 | - // set language | |
| 393 | - $this->term->set_language( (int) $cat, $lang ); | |
| 394 | - | |
| 395 | - // this is a translation of the default category | |
| 396 | - $default = (int) get_option( 'default_category' ); | |
| 397 | - $translations = $this->term->get_translations( $default ); | |
| 398 | - if ( empty( $translations ) ) { | |
| 399 | - if ( $lg = $this->term->get_language( $default ) ) { | |
| 400 | - $translations[ $lg->slug ] = $default; | |
| 401 | - } | |
| 402 | - else { | |
| 403 | - $translations = array(); | |
| 404 | - } | |
| 405 | - } | |
| 406 | - | |
| 407 | - $this->term->save_translations( (int) $cat, $translations ); | |
| 408 | - } | |
| 409 | - | |
| 410 | - /** | |
| 411 | 402 | * It is possible to have several terms with the same name in the same taxonomy ( one per language ) |
| 412 | - * but the native term_exists will return true even if only one exists | |
| 413 | - * so here the function adds the language parameter | |
| 403 | + * but the native term_exists() will return true even if only one exists. | |
| 404 | + * So here the function adds the language parameter. | |
| 414 | 405 | * |
| 415 | 406 | * @since 1.4 |
| 416 | 407 | * |
| 417 | - * @param string $term_name the term name | |
| 418 | - * @param string $taxonomy taxonomy name | |
| 419 | - * @param int $parent parent term id | |
| 420 | - * @param string|object $language the language slug or object | |
| 421 | - * @return null|int the term_id of the found term | |
| 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. | |
| 422 | 413 | */ |
| 423 | 414 | public function term_exists( $term_name, $taxonomy, $parent, $language ) { |
| 424 | 415 | global $wpdb; |
| 425 | 416 | |
| @@ -440,17 +431,17 @@ | ||
| 440 | 431 | return $wpdb->get_var( $select . $join . $where ); |
| 441 | 432 | } |
| 442 | 433 | |
| 443 | 434 | /** |
| 444 | - * Checks if a term slug exists in a given language, taxonomy, hierarchy | |
| 435 | + * Checks if a term slug exists in a given language, taxonomy, hierarchy. | |
| 445 | 436 | * |
| 446 | 437 | * @since 1.9 |
| 447 | - * @since 2.8 Moved from PLL_Share_Term_Slug::term_exists() to PLL_Model::term_exists_by_slug() | |
| 438 | + * @since 2.8 Moved from PLL_Share_Term_Slug::term_exists() to PLL_Model::term_exists_by_slug(). | |
| 448 | 439 | * |
| 449 | - * @param string $slug The term slug to test. | |
| 450 | - * @param string|object $language The language slug or object. | |
| 451 | - * @param string $taxonomy Optional taxonomy name. | |
| 452 | - * @param int $parent Optional parent term id. | |
| 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. | |
| 453 | 444 | * @return null|int The term_id of the found term. |
| 454 | 445 | */ |
| 455 | 446 | public function term_exists_by_slug( $slug, $language, $taxonomy = '', $parent = 0 ) { |
| 456 | 447 | global $wpdb; |
| @@ -478,10 +469,22 @@ | ||
| 478 | 469 | * Gets the number of posts per language in a date, author or post type archive. |
| 479 | 470 | * |
| 480 | 471 | * @since 1.2 |
| 481 | 472 | * |
| 482 | - * @param object $lang PLL_Language instance. | |
| 483 | - * @param array $q WP_Query arguments ( accepted: post_type, m, year, monthnum, day, author, author_name, post_format, post_status ). | |
| 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 | + * } | |
| 484 | 487 | * @return int |
| 485 | 488 | */ |
| 486 | 489 | public function count_posts( $lang, $q = array() ) { |
| 487 | 490 | global $wpdb; |
| @@ -508,9 +511,9 @@ | ||
| 508 | 511 | if ( false === $counts ) { |
| 509 | 512 | $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts}"; |
| 510 | 513 | $join = $this->post->join_clause(); |
| 511 | 514 | $where = sprintf( " WHERE post_status = '%s'", esc_sql( $q['post_status'] ) ); |
| 512 | - $where .= sprintf( " AND {$wpdb->posts}.post_type IN ( '%s' )", join( "', '", esc_sql( $q['post_type'] ) ) ); | |
| 515 | + $where .= sprintf( " AND {$wpdb->posts}.post_type IN ( '%s' )", implode( "', '", esc_sql( $q['post_type'] ) ) ); | |
| 513 | 516 | $where .= $this->post->where_clause( $this->get_languages_list() ); |
| 514 | 517 | $groupby = ' GROUP BY pll_tr.term_taxonomy_id'; |
| 515 | 518 | |
| 516 | 519 | if ( ! empty( $q['m'] ) ) { |
| @@ -570,13 +573,13 @@ | ||
| 570 | 573 | return empty( $counts[ $lang->term_taxonomy_id ] ) ? 0 : $counts[ $lang->term_taxonomy_id ]; |
| 571 | 574 | } |
| 572 | 575 | |
| 573 | 576 | /** |
| 574 | - * Setup the links model based on options | |
| 577 | + * Setup the links model based on options. | |
| 575 | 578 | * |
| 576 | 579 | * @since 1.2 |
| 577 | 580 | * |
| 578 | - * @return object implementing "links_model interface" | |
| 581 | + * @return PLL_Links_Model | |
| 579 | 582 | */ |
| 580 | 583 | public function get_links_model() { |
| 581 | 584 | $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' ); |
| 582 | 585 | $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default'; |
| @@ -581,14 +584,14 @@ | ||
| 581 | 584 | $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' ); |
| 582 | 585 | $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default'; |
| 583 | 586 | |
| 584 | 587 | /** |
| 585 | - * Filter the links model class to use | |
| 586 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 588 | + * Filters the links model class to use. | |
| 589 | + * /!\ this filter is fired *before* the $polylang object is available. | |
| 587 | 590 | * |
| 588 | 591 | * @since 2.1.1 |
| 589 | 592 | * |
| 590 | - * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain | |
| 593 | + * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain. | |
| 591 | 594 | */ |
| 592 | 595 | $class = apply_filters( 'pll_links_model', $class ); |
| 593 | 596 | |
| 594 | 597 | return new $class( $this ); |
| @@ -594,80 +597,110 @@ | ||
| 594 | 597 | return new $class( $this ); |
| 595 | 598 | } |
| 596 | 599 | |
| 597 | 600 | /** |
| 598 | - * Some backward compatibility with Polylang < 1.8 | |
| 599 | - * allows for example to call $polylang->model->get_post_languages( $post_id ) instead of $polylang->model->post->get_language( $post_id ) | |
| 600 | - * this works but should be slower than the direct call, thus an error is triggered in debug mode | |
| 601 | + * Returns posts and terms ids without language ( used in settings ). | |
| 601 | 602 | * |
| 602 | - * @since 1.8 | |
| 603 | + * @since 0.9 | |
| 604 | + * @since 2.2.6 Add the $limit argument. | |
| 603 | 605 | * |
| 604 | - * @param string $func Function name | |
| 605 | - * @param array $args Function arguments | |
| 606 | + * @param int $limit Max number of posts or terms to return. Defaults to -1 (no limit). | |
| 607 | + * @return array { | |
| 608 | + * Objects without language. | |
| 609 | + * | |
| 610 | + * @type int[] $posts Array of post ids. | |
| 611 | + * @type int[] $terms Array of term ids. | |
| 612 | + * } | |
| 606 | 613 | */ |
| 607 | - public function __call( $func, $args ) { | |
| 608 | - $f = $func; | |
| 614 | + public function get_objects_with_no_lang( $limit = -1 ) { | |
| 615 | + /** | |
| 616 | + * Filters the max number of posts or terms to return when searching objects with no language. | |
| 617 | + * This filter can be used to decrease the memory usage in case the number of objects | |
| 618 | + * without language is too big. Using a negative value is equivalent to have no limit. | |
| 619 | + * | |
| 620 | + * @since 2.2.6 | |
| 621 | + * | |
| 622 | + * @param int $limit Max number of posts or terms to retrieve from the database. | |
| 623 | + */ | |
| 624 | + $limit = (int) apply_filters( 'get_objects_with_no_lang_limit', $limit ); | |
| 609 | 625 | |
| 610 | - switch ( $func ) { | |
| 611 | - case 'get_object_term': | |
| 612 | - $o = ( false === strpos( $args[1], 'term' ) ) ? 'post' : 'term'; | |
| 613 | - break; | |
| 626 | + $posts = $this->get_posts_with_no_lang( $this->get_translated_post_types(), $limit ); | |
| 627 | + $terms = $this->get_terms_with_no_lang( $this->get_translated_taxonomies(), $limit ); | |
| 614 | 628 | |
| 615 | - case 'save_translations': | |
| 616 | - case 'delete_translation': | |
| 617 | - case 'get_translations': | |
| 618 | - case 'get_translation': | |
| 619 | - case 'join_clause': | |
| 620 | - $o = ( 'post' == $args[0] || $this->is_translated_post_type( $args[0] ) ) ? 'post' : ( 'term' == $args[0] || $this->is_translated_taxonomy( $args[0] ) ? 'term' : false ); | |
| 621 | - unset( $args[0] ); | |
| 622 | - break; | |
| 629 | + /** | |
| 630 | + * Filters the list of untranslated posts ids and terms ids | |
| 631 | + * | |
| 632 | + * @since 0.9 | |
| 633 | + * | |
| 634 | + * @param array|false $objects false if no ids found, list of post and/or term ids otherwise. | |
| 635 | + */ | |
| 636 | + return apply_filters( 'pll_get_objects_with_no_lang', empty( $posts ) && empty( $terms ) ? false : array( 'posts' => $posts, 'terms' => $terms ) ); | |
| 637 | + } | |
| 623 | 638 | |
| 624 | - case 'set_post_language': | |
| 625 | - case 'get_post_language': | |
| 626 | - case 'set_term_language': | |
| 627 | - case 'get_term_language': | |
| 628 | - case 'delete_term_language': | |
| 629 | - case 'get_post': | |
| 630 | - case 'get_term': | |
| 631 | - $str = explode( '_', $func ); | |
| 632 | - $f = empty( $str[2] ) ? $str[0] : $str[0] . '_' . $str[2]; | |
| 633 | - $o = $str[1]; | |
| 634 | - break; | |
| 639 | + /** | |
| 640 | + * Returns ids of post without language. | |
| 641 | + * | |
| 642 | + * @since 3.1 | |
| 643 | + * | |
| 644 | + * @param string|string[] $post_types A translated post type or an array of translated post types. | |
| 645 | + * @param int $limit Max number of posts to return. | |
| 646 | + * @return int[] | |
| 647 | + */ | |
| 648 | + public function get_posts_with_no_lang( $post_types, $limit ) { | |
| 649 | + return get_posts( | |
| 650 | + array( | |
| 651 | + 'numberposts' => $limit, | |
| 652 | + 'nopaging' => $limit <= 0, | |
| 653 | + 'post_type' => $post_types, | |
| 654 | + 'post_status' => 'any', | |
| 655 | + 'fields' => 'ids', | |
| 656 | + 'tax_query' => array( | |
| 657 | + array( | |
| 658 | + 'taxonomy' => 'language', | |
| 659 | + 'terms' => $this->get_languages_list( array( 'fields' => 'term_id' ) ), | |
| 660 | + 'operator' => 'NOT IN', | |
| 661 | + ), | |
| 662 | + ), | |
| 663 | + ) | |
| 664 | + ); | |
| 665 | + } | |
| 635 | 666 | |
| 636 | - case 'where_clause': | |
| 637 | - case 'get_objects_in_language': | |
| 638 | - $o = $args[1]; | |
| 639 | - unset( $args[1] ); | |
| 640 | - break; | |
| 641 | - } | |
| 667 | + /** | |
| 668 | + * Returns ids of terms without language. | |
| 669 | + * | |
| 670 | + * @since 3.1 | |
| 671 | + * | |
| 672 | + * @param string|string[] $taxonomies A translated taxonomy or an array of taxonomies post types. | |
| 673 | + * @param int $limit Max number of terms to return. | |
| 674 | + * @return int[] | |
| 675 | + */ | |
| 676 | + public function get_terms_with_no_lang( $taxonomies, $limit ) { | |
| 677 | + global $wpdb; | |
| 642 | 678 | |
| 643 | - if ( ! empty( $o ) && is_object( $this->$o ) && method_exists( $this->$o, $f ) ) { | |
| 644 | - if ( WP_DEBUG ) { | |
| 645 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 646 | - $i = 1 + empty( $debug[1]['line'] ); // the file and line are in $debug[2] if the function was called using call_user_func | |
| 679 | + $taxonomies = (array) $taxonomies; | |
| 647 | 680 | |
| 648 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 649 | - sprintf( | |
| 650 | - '%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", | |
| 651 | - esc_html( $func ), | |
| 652 | - esc_html( $o ), | |
| 653 | - esc_html( $f ), | |
| 654 | - esc_html( $debug[ $i ]['file'] ), | |
| 655 | - absint( $debug[ $i ]['line'] ) | |
| 656 | - ) | |
| 657 | - ); | |
| 658 | - } | |
| 659 | - return call_user_func_array( array( $this->$o, $f ), $args ); | |
| 681 | + $sql = sprintf( | |
| 682 | + "SELECT {$wpdb->term_taxonomy}.term_id FROM {$wpdb->term_taxonomy} | |
| 683 | + WHERE taxonomy IN ('%s') | |
| 684 | + AND {$wpdb->term_taxonomy}.term_id NOT IN ( | |
| 685 | + SELECT object_id FROM {$wpdb->term_relationships} WHERE term_taxonomy_id IN (%s) | |
| 686 | + ) | |
| 687 | + %s", | |
| 688 | + implode( "','", array_map( 'esc_sql', $taxonomies ) ), | |
| 689 | + implode( ',', array_map( 'intval', $this->get_languages_list( array( 'fields' => 'tl_term_taxonomy_id' ) ) ) ), | |
| 690 | + $limit > 0 ? sprintf( 'LIMIT %d', intval( $limit ) ) : '' | |
| 691 | + ); | |
| 692 | + | |
| 693 | + $key = md5( $sql ); | |
| 694 | + $last_changed = wp_cache_get_last_changed( 'terms' ); | |
| 695 | + $cache_key = "terms_no_lang:{$key}:{$last_changed}"; | |
| 696 | + | |
| 697 | + $term_ids = wp_cache_get( $cache_key, 'terms' ); | |
| 698 | + | |
| 699 | + if ( false === $term_ids ) { | |
| 700 | + $term_ids = $wpdb->get_col( $sql ); // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared | |
| 701 | + wp_cache_set( $cache_key, $term_ids, 'terms' ); | |
| 660 | 702 | } |
| 661 | 703 | |
| 662 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 663 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 664 | - sprintf( | |
| 665 | - 'Call to undefined function PLL()->model->%1$s() in %2$s on line %3$s' . "\nError handler", | |
| 666 | - esc_html( $func ), | |
| 667 | - esc_html( $debug[0]['file'] ), | |
| 668 | - absint( $debug[0]['line'] ) | |
| 669 | - ), | |
| 670 | - E_USER_ERROR | |
| 671 | - ); | |
| 704 | + return $term_ids; | |
| 672 | 705 | } |
| 673 | 706 | } |
