| @@ -1,5 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | 7 | * Setups the language and translations model based on WordPress taxonomies |
| 5 | 8 | * |
| @@ -5,29 +8,77 @@ | ||
| 5 | 8 | * |
| 6 | 9 | * @since 1.2 |
| 7 | 10 | */ |
| 8 | 11 | class PLL_Model { |
| 9 | - public $cache; // Our internal non persistent cache object | |
| 12 | + /** | |
| 13 | + * Internal non persistent cache object. | |
| 14 | + * | |
| 15 | + * @var PLL_Cache<mixed> | |
| 16 | + */ | |
| 17 | + public $cache; | |
| 18 | + | |
| 19 | + /** | |
| 20 | + * Stores the plugin options. | |
| 21 | + * | |
| 22 | + * @var array | |
| 23 | + */ | |
| 10 | 24 | public $options; |
| 11 | - public $post, $term; // Translated objects models | |
| 12 | 25 | |
| 13 | 26 | /** |
| 14 | - * Constructor | |
| 15 | - * setups translated objects sub models | |
| 16 | - * setups filters and actions | |
| 27 | + * Translatable objects registry. | |
| 17 | 28 | * |
| 29 | + * @since 3.4 | |
| 30 | + * | |
| 31 | + * @var PLL_Translatable_Objects | |
| 32 | + */ | |
| 33 | + public $translatable_objects; | |
| 34 | + | |
| 35 | + /** | |
| 36 | + * Translated post model. | |
| 37 | + * | |
| 38 | + * @var PLL_Translated_Post | |
| 39 | + */ | |
| 40 | + public $post; | |
| 41 | + | |
| 42 | + /** | |
| 43 | + * Translated term model. | |
| 44 | + * | |
| 45 | + * @var PLL_Translated_Term | |
| 46 | + */ | |
| 47 | + public $term; | |
| 48 | + | |
| 49 | + /** | |
| 50 | + * Flag set to true during the language objects creation. | |
| 51 | + * | |
| 52 | + * @var bool | |
| 53 | + */ | |
| 54 | + private $is_creating_language_objects = false; | |
| 55 | + | |
| 56 | + /** | |
| 57 | + * Tells if {@see PLL_Model::get_languages_list()} can be used. | |
| 58 | + * | |
| 59 | + * @var bool | |
| 60 | + */ | |
| 61 | + private $languages_ready = false; | |
| 62 | + | |
| 63 | + /** | |
| 64 | + * Constructor. | |
| 65 | + * Setups translated objects sub models. | |
| 66 | + * Setups filters and actions. | |
| 67 | + * | |
| 18 | 68 | * @since 1.2 |
| 19 | 69 | * |
| 20 | - * @param array $options Polylang options | |
| 70 | + * @param array $options Polylang options. | |
| 21 | 71 | */ |
| 22 | 72 | public function __construct( &$options ) { |
| 23 | 73 | $this->options = &$options; |
| 24 | 74 | |
| 25 | 75 | $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 | |
| 76 | + $this->translatable_objects = new PLL_Translatable_Objects(); | |
| 77 | + $this->post = $this->translatable_objects->register( new PLL_Translated_Post( $this ) ); // Translated post sub model. | |
| 78 | + $this->term = $this->translatable_objects->register( new PLL_Translated_Term( $this ) ); // Translated term sub model. | |
| 28 | 79 | |
| 29 | - // We need to clean languages cache when editing a language and when modifying the permalink structure | |
| 80 | + // We need to clean languages cache when editing a language and when modifying the permalink structure. | |
| 30 | 81 | add_action( 'edited_term_taxonomy', array( $this, 'clean_languages_cache' ), 10, 2 ); |
| 31 | 82 | add_action( 'update_option_permalink_structure', array( $this, 'clean_languages_cache' ) ); |
| 32 | 83 | add_action( 'update_option_siteurl', array( $this, 'clean_languages_cache' ) ); |
| 33 | 84 | add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) ); |
| @@ -33,106 +84,144 @@ | ||
| 33 | 84 | add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) ); |
| 34 | 85 | |
| 35 | 86 | add_filter( 'get_terms_args', array( $this, 'get_terms_args' ) ); |
| 36 | 87 | |
| 37 | - // Just in case someone would like to display the language description ;- ) | |
| 88 | + // Just in case someone would like to display the language description ;). | |
| 38 | 89 | add_filter( 'language_description', '__return_empty_string' ); |
| 39 | 90 | } |
| 40 | 91 | |
| 41 | 92 | /** |
| 42 | - * Returns the list of available languages | |
| 43 | - * caches the list in a db transient ( except flags ), unless PLL_CACHE_LANGUAGES is set to false | |
| 44 | - * caches the list ( with flags ) in the private property $languages | |
| 93 | + * Checks if there are languages or not. | |
| 45 | 94 | * |
| 46 | - * List of parameters accepted in $args: | |
| 95 | + * @since 3.3 | |
| 47 | 96 | * |
| 48 | - * hide_empty => hides languages with no posts if set to true ( defaults to false ) | |
| 49 | - * fields => return only that field if set ( see PLL_Language for a list of fields ) | |
| 97 | + * @return bool True if there are, false otherwise. | |
| 98 | + */ | |
| 99 | + public function has_languages() { | |
| 100 | + if ( ! empty( $this->cache->get( 'languages' ) ) ) { | |
| 101 | + return true; | |
| 102 | + } | |
| 103 | + | |
| 104 | + if ( ! empty( get_transient( 'pll_languages_list' ) ) ) { | |
| 105 | + return true; | |
| 106 | + } | |
| 107 | + | |
| 108 | + return ! empty( $this->get_language_terms() ); | |
| 109 | + } | |
| 110 | + | |
| 111 | + /** | |
| 112 | + * Returns the list of available languages. | |
| 113 | + * - Stores the list in a db transient (except flags), unless `PLL_CACHE_LANGUAGES` is set to false. | |
| 114 | + * - Caches the list (with flags) in a `PLL_Cache` object. | |
| 50 | 115 | * |
| 51 | 116 | * @since 0.1 |
| 52 | 117 | * |
| 53 | - * @param array $args | |
| 54 | - * @return array|string|int list of PLL_Language objects or PLL_Language object properties | |
| 118 | + * @param array $args { | |
| 119 | + * @type bool $hide_empty Hides languages with no posts if set to `true` (defaults to `false`). | |
| 120 | + * @type bool $hide_default Hides default language from the list (default to `false`). | |
| 121 | + * @type string $fields Returns only that field if set; {@see PLL_Language} for a list of fields. | |
| 122 | + * } | |
| 123 | + * @return array List of PLL_Language objects or PLL_Language object properties. | |
| 55 | 124 | */ |
| 56 | 125 | public function get_languages_list( $args = array() ) { |
| 57 | - if ( false === $languages = $this->cache->get( 'languages' ) ) { | |
| 126 | + if ( ! $this->are_languages_ready() ) { | |
| 127 | + _doing_it_wrong( | |
| 128 | + __METHOD__ . '()', | |
| 129 | + "It must not be called before the hook 'pll_pre_init'.", | |
| 130 | + '3.4' | |
| 131 | + ); | |
| 132 | + } | |
| 58 | 133 | |
| 59 | - // Create the languages from taxonomies | |
| 60 | - if ( ( defined( 'PLL_CACHE_LANGUAGES' ) && ! PLL_CACHE_LANGUAGES ) || false === ( $languages = get_transient( 'pll_languages_list' ) ) ) { | |
| 61 | - $languages = get_terms( 'language', array( 'hide_empty' => false, 'orderby' => 'term_group' ) ); | |
| 62 | - $languages = empty( $languages ) || is_wp_error( $languages ) ? array() : $languages; | |
| 134 | + $languages = $this->cache->get( 'languages' ); | |
| 63 | 135 | |
| 64 | - $term_languages = get_terms( 'term_language', array( 'hide_empty' => false ) ); | |
| 65 | - $term_languages = empty( $term_languages ) || is_wp_error( $term_languages ) ? | |
| 66 | - array() : array_combine( wp_list_pluck( $term_languages, 'slug' ), $term_languages ); | |
| 136 | + if ( ! is_array( $languages ) ) { | |
| 137 | + // Bail out early if languages are currently created to avoid an infinite loop. | |
| 138 | + if ( $this->is_creating_language_objects ) { | |
| 139 | + return array(); | |
| 140 | + } | |
| 67 | 141 | |
| 68 | - if ( ! empty( $languages ) && ! empty( $term_languages ) ) { | |
| 69 | - // Don't use array_map + create_function to instantiate an autoloaded class as it breaks badly in old versions of PHP | |
| 70 | - foreach ( $languages as $k => $v ) { | |
| 71 | - $languages[ $k ] = new PLL_Language( $v, $term_languages[ 'pll_' . $v->slug ] ); | |
| 72 | - } | |
| 142 | + $this->is_creating_language_objects = true; | |
| 73 | 143 | |
| 74 | - // We will need the languages list to allow its access in the filter below | |
| 75 | - $this->cache->set( 'languages', $languages ); | |
| 144 | + if ( ! pll_get_constant( 'PLL_CACHE_LANGUAGES', true ) ) { | |
| 145 | + // Create the languages from taxonomies. | |
| 146 | + $languages = $this->get_languages_from_taxonomies(); | |
| 147 | + } else { | |
| 148 | + $languages = get_transient( 'pll_languages_list' ); | |
| 76 | 149 | |
| 77 | - /** | |
| 78 | - * Filter the list of languages *before* it is stored in the persistent cache | |
| 79 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 80 | - * | |
| 81 | - * @since 1.7.5 | |
| 82 | - * | |
| 83 | - * @param array $languages the list of language objects | |
| 84 | - * @param object $model PLL_Model object | |
| 85 | - */ | |
| 86 | - $languages = apply_filters( 'pll_languages_list', $languages, $this ); | |
| 150 | + if ( empty( $languages ) || ! is_array( $languages ) || empty( reset( $languages )['term_props'] ) ) { // Test `term_props` in case we got a transient older than 3.4. | |
| 151 | + // Create the languages from taxonomies. | |
| 152 | + $languages = $this->get_languages_from_taxonomies(); | |
| 153 | + } else { | |
| 154 | + // Create the languages directly from arrays stored in the transient. | |
| 155 | + $languages = array_map( | |
| 156 | + array( new PLL_Language_Factory( $this->options ), 'get' ), | |
| 157 | + $languages | |
| 158 | + ); | |
| 87 | 159 | |
| 88 | - // Don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache | |
| 89 | - // Thanks to captin411 for catching this! | |
| 90 | - // See https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255; | |
| 91 | - set_transient( 'pll_languages_list', array_map( 'get_object_vars', $languages ) ); | |
| 92 | - } | |
| 93 | - else { | |
| 94 | - $languages = array(); // In case something went wrong | |
| 95 | - } | |
| 96 | - } | |
| 160 | + // Remove potential empty language. | |
| 161 | + $languages = array_filter( $languages ); | |
| 97 | 162 | |
| 98 | - // Create the languages directly from arrays stored in transients | |
| 99 | - else { | |
| 100 | - foreach ( $languages as $k => $v ) { | |
| 101 | - $languages[ $k ] = new PLL_Language( $v ); | |
| 163 | + // Re-index. | |
| 164 | + $languages = array_values( $languages ); | |
| 102 | 165 | } |
| 103 | 166 | } |
| 104 | 167 | |
| 105 | - // Custom flags | |
| 106 | - if ( ! PLL_ADMIN ) { | |
| 107 | - foreach ( $languages as $language ) { | |
| 108 | - $language->set_custom_flag(); | |
| 109 | - } | |
| 110 | - } | |
| 111 | - | |
| 112 | 168 | /** |
| 113 | - * Filter the list of languages *after* it is stored in the persistent cache | |
| 114 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 169 | + * Filters the list of languages *after* it is stored in the persistent cache. | |
| 170 | + * /!\ This filter is fired *before* the $polylang object is available. | |
| 115 | 171 | * |
| 116 | 172 | * @since 1.8 |
| 173 | + * @since 3.4 Deprecated. If you used this hook to filter URLs, you may hook `'site_url'` instead. | |
| 174 | + * @deprecated | |
| 117 | 175 | * |
| 118 | - * @param array $languages the list of language objects | |
| 176 | + * @param PLL_Language[] $languages The list of language objects. | |
| 119 | 177 | */ |
| 120 | - $languages = apply_filters( 'pll_after_languages_cache', $languages ); | |
| 121 | - $this->cache->set( 'languages', $languages ); | |
| 178 | + $languages = apply_filters_deprecated( 'pll_after_languages_cache', array( $languages ), '3.4' ); | |
| 179 | + | |
| 180 | + if ( $this->are_languages_ready() ) { | |
| 181 | + $this->cache->set( 'languages', $languages ); | |
| 182 | + } | |
| 183 | + | |
| 184 | + $this->is_creating_language_objects = false; | |
| 122 | 185 | } |
| 123 | 186 | |
| 124 | - $args = wp_parse_args( $args, array( 'hide_empty' => false ) ); | |
| 187 | + $languages = array_filter( | |
| 188 | + $languages, | |
| 189 | + function ( $lang ) use ( $args ) { | |
| 190 | + $keep_empty = empty( $args['hide_empty'] ) || $lang->get_tax_prop( 'language', 'count' ); | |
| 191 | + $keep_default = empty( $args['hide_default'] ) || ! $lang->is_default; | |
| 192 | + return $keep_empty && $keep_default; | |
| 193 | + } | |
| 194 | + ); | |
| 125 | 195 | |
| 126 | - // Remove empty languages if requested | |
| 127 | - if ( $args['hide_empty'] ) { | |
| 128 | - $languages = wp_list_filter( $languages, array( 'count' => 0 ), 'NOT' ); | |
| 129 | - } | |
| 196 | + $languages = array_values( $languages ); // Re-index. | |
| 130 | 197 | |
| 131 | 198 | return empty( $args['fields'] ) ? $languages : wp_list_pluck( $languages, $args['fields'] ); |
| 132 | 199 | } |
| 133 | 200 | |
| 134 | 201 | /** |
| 202 | + * Tells if {@see PLL_Model::get_languages_list()} can be used. | |
| 203 | + * | |
| 204 | + * @since 3.4 | |
| 205 | + * | |
| 206 | + * @return bool | |
| 207 | + */ | |
| 208 | + public function are_languages_ready() { | |
| 209 | + return $this->languages_ready; | |
| 210 | + } | |
| 211 | + | |
| 212 | + /** | |
| 213 | + * Sets the internal property `$languages_ready` to `true`, telling that {@see PLL_Model::get_languages_list()} can be used. | |
| 214 | + * | |
| 215 | + * @since 3.4 | |
| 216 | + * | |
| 217 | + * @return void | |
| 218 | + */ | |
| 219 | + public function set_languages_ready() { | |
| 220 | + $this->languages_ready = true; | |
| 221 | + } | |
| 222 | + | |
| 223 | + /** | |
| 135 | 224 | * Cleans language cache |
| 136 | 225 | * can be called directly with no parameter |
| 137 | 226 | * called by the 'edited_term_taxonomy' filter with 2 parameters when count needs to be updated |
| 138 | 227 | * |
| @@ -139,11 +228,12 @@ | ||
| 139 | 228 | * @since 1.2 |
| 140 | 229 | * |
| 141 | 230 | * @param int $term not used |
| 142 | 231 | * @param string $taxonomy taxonomy name |
| 232 | + * @return void | |
| 143 | 233 | */ |
| 144 | 234 | public function clean_languages_cache( $term = 0, $taxonomy = null ) { |
| 145 | - if ( empty( $taxonomy ) || 'language' == $taxonomy ) { | |
| 235 | + if ( empty( $taxonomy ) || 'language' === $taxonomy ) { | |
| 146 | 236 | delete_transient( 'pll_languages_list' ); |
| 147 | 237 | $this->cache->clean(); |
| 148 | 238 | } |
| 149 | 239 | } |
| @@ -156,9 +246,11 @@ | ||
| 156 | 246 | * @param array $args WP_Term_Query arguments |
| 157 | 247 | * @return array |
| 158 | 248 | */ |
| 159 | 249 | public function get_terms_args( $args ) { |
| 160 | - if ( isset( $args['taxonomy'] ) && ! array_diff( (array) $args['taxonomy'], array( 'language', 'term_language', 'post_translations', 'term_translations' ) ) ) { | |
| 250 | + $taxonomies = $this->translatable_objects->get_taxonomy_names(); | |
| 251 | + | |
| 252 | + if ( isset( $args['taxonomy'] ) && ! array_diff( (array) $args['taxonomy'], $taxonomies ) ) { | |
| 161 | 253 | $args['update_term_meta_cache'] = false; |
| 162 | 254 | } |
| 163 | 255 | return $args; |
| 164 | 256 | } |
| @@ -163,42 +255,67 @@ | ||
| 163 | 255 | return $args; |
| 164 | 256 | } |
| 165 | 257 | |
| 166 | 258 | /** |
| 167 | - * Returns the language by its term_id, tl_term_id, slug or locale | |
| 259 | + * Returns the language by its term_id, tl_term_id, slug or locale. | |
| 168 | 260 | * |
| 169 | 261 | * @since 0.1 |
| 262 | + * @since 3.4 Allow to get a language by `term_taxonomy_id`. | |
| 170 | 263 | * |
| 171 | - * @param int|string $value term_id, tl_term_id, slug or locale of the queried language | |
| 172 | - * @return object|bool PLL_Language object, false if no language found | |
| 264 | + * @param mixed $value `term_id`, `term_taxonomy_id`, `slug`, `locale`, or `w3c` of the queried language. | |
| 265 | + * `term_id` and `term_taxonomy_id` can be fetched for any language taxonomy. | |
| 266 | + * /!\ For the `term_taxonomy_id`, prefix the ID by `tt:` (ex: `"tt:{$tt_id}"`), | |
| 267 | + * this is to prevent confusion between `term_id` and `term_taxonomy_id`. | |
| 268 | + * @return PLL_Language|false Language object, false if no language found. | |
| 173 | 269 | */ |
| 174 | 270 | public function get_language( $value ) { |
| 175 | 271 | if ( is_object( $value ) ) { |
| 176 | - return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // will force cast to PLL_Language | |
| 272 | + return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // Will force cast to PLL_Language. | |
| 177 | 273 | } |
| 178 | 274 | |
| 179 | - if ( false === $return = $this->cache->get( 'language:' . $value ) ) { | |
| 180 | - foreach ( $this->get_languages_list() as $lang ) { | |
| 181 | - $this->cache->set( 'language:' . $lang->term_id, $lang ); | |
| 182 | - $this->cache->set( 'language:' . $lang->tl_term_id, $lang ); | |
| 183 | - $this->cache->set( 'language:' . $lang->slug, $lang ); | |
| 184 | - $this->cache->set( 'language:' . $lang->locale, $lang ); | |
| 185 | - $this->cache->set( 'language:' . $lang->w3c, $lang ); | |
| 275 | + $return = $this->cache->get( 'language:' . $value ); | |
| 276 | + | |
| 277 | + if ( $return instanceof PLL_Language ) { | |
| 278 | + return $return; | |
| 279 | + } | |
| 280 | + | |
| 281 | + foreach ( $this->get_languages_list() as $lang ) { | |
| 282 | + foreach ( $lang->get_tax_props() as $props ) { | |
| 283 | + $this->cache->set( 'language:' . $props['term_id'], $lang ); | |
| 284 | + $this->cache->set( 'language:tt:' . $props['term_taxonomy_id'], $lang ); | |
| 186 | 285 | } |
| 187 | - $return = $this->cache->get( 'language:' . $value ); | |
| 286 | + $this->cache->set( 'language:' . $lang->slug, $lang ); | |
| 287 | + $this->cache->set( 'language:' . $lang->locale, $lang ); | |
| 288 | + $this->cache->set( 'language:' . $lang->w3c, $lang ); | |
| 188 | 289 | } |
| 189 | 290 | |
| 190 | - return $return; | |
| 291 | + /** @var PLL_Language|false */ | |
| 292 | + return $this->cache->get( 'language:' . $value ); | |
| 191 | 293 | } |
| 192 | 294 | |
| 193 | 295 | /** |
| 194 | - * Adds terms clauses to get_terms to filter them by languages - used in both frontend and admin | |
| 296 | + * Returns the default language. | |
| 195 | 297 | * |
| 298 | + * @since 3.4 | |
| 299 | + * | |
| 300 | + * @return PLL_Language|false Default language object, `false` if no language found. | |
| 301 | + */ | |
| 302 | + public function get_default_language() { | |
| 303 | + if ( empty( $this->options['default_lang'] ) ) { | |
| 304 | + return false; | |
| 305 | + } | |
| 306 | + | |
| 307 | + return $this->get_language( $this->options['default_lang'] ); | |
| 308 | + } | |
| 309 | + | |
| 310 | + /** | |
| 311 | + * Adds terms clauses to the term query to filter them by languages. | |
| 312 | + * | |
| 196 | 313 | * @since 1.2 |
| 197 | 314 | * |
| 198 | - * @param array $clauses the list of sql clauses in terms query | |
| 199 | - * @param object $lang PLL_Language object | |
| 200 | - * @return array modified list of clauses | |
| 315 | + * @param string[] $clauses The list of sql clauses in terms query. | |
| 316 | + * @param PLL_Language|false $lang PLL_Language object. | |
| 317 | + * @return string[] Modified list of clauses. | |
| 201 | 318 | */ |
| 202 | 319 | public function terms_clauses( $clauses, $lang ) { |
| 203 | 320 | if ( ! empty( $lang ) && false === strpos( $clauses['join'], 'pll_tr' ) ) { |
| 204 | 321 | $clauses['join'] .= $this->term->join_clause(); |
| @@ -207,119 +324,78 @@ | ||
| 207 | 324 | return $clauses; |
| 208 | 325 | } |
| 209 | 326 | |
| 210 | 327 | /** |
| 211 | - * Returns post types that need to be translated | |
| 212 | - * the post types list is cached for better better performance | |
| 213 | - * wait for 'after_setup_theme' to apply the cache to allow themes adding the filter in functions.php | |
| 328 | + * Returns post types that need to be translated. | |
| 329 | + * The post types list is cached for better better performance. | |
| 330 | + * The method waits for 'after_setup_theme' to apply the cache | |
| 331 | + * to allow themes adding the filter in functions.php. | |
| 214 | 332 | * |
| 215 | 333 | * @since 1.2 |
| 216 | 334 | * |
| 217 | - * @param bool $filter true if we should return only valid registered post types | |
| 218 | - * @return array post type names for which Polylang manages languages and translations | |
| 335 | + * @param bool $filter True if we should return only valid registered post types. | |
| 336 | + * @return string[] Post type names for which Polylang manages languages and translations. | |
| 219 | 337 | */ |
| 220 | 338 | public function get_translated_post_types( $filter = true ) { |
| 221 | - if ( false === $post_types = $this->cache->get( 'post_types' ) ) { | |
| 222 | - $post_types = array( 'post' => 'post', 'page' => 'page', 'wp_block' => 'wp_block' ); | |
| 223 | - | |
| 224 | - if ( ! empty( $this->options['media_support'] ) ) { | |
| 225 | - $post_types['attachment'] = 'attachment'; | |
| 226 | - } | |
| 227 | - | |
| 228 | - if ( ! empty( $this->options['post_types'] ) && is_array( $this->options['post_types'] ) ) { | |
| 229 | - $post_types = array_merge( $post_types, array_combine( $this->options['post_types'], $this->options['post_types'] ) ); | |
| 230 | - } | |
| 231 | - | |
| 232 | - /** | |
| 233 | - * Filter the list of post types available for translation. | |
| 234 | - * The default are post types which have the parameter ‘public’ set to true. | |
| 235 | - * The filter must be added soon in the WordPress loading process: | |
| 236 | - * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. | |
| 237 | - * | |
| 238 | - * @since 0.8 | |
| 239 | - * | |
| 240 | - * @param array $post_types list of post type names | |
| 241 | - * @param bool $is_settings true when displaying the list of custom post types in Polylang settings | |
| 242 | - */ | |
| 243 | - $post_types = apply_filters( 'pll_get_post_types', $post_types, false ); | |
| 244 | - | |
| 245 | - if ( did_action( 'after_setup_theme' ) ) { | |
| 246 | - $this->cache->set( 'post_types', $post_types ); | |
| 247 | - } | |
| 248 | - } | |
| 249 | - | |
| 250 | - return $filter ? array_intersect( $post_types, get_post_types() ) : $post_types; | |
| 339 | + return $this->translatable_objects->get( 'post' )->get_translated_object_types( $filter ); | |
| 251 | 340 | } |
| 252 | 341 | |
| 253 | 342 | /** |
| 254 | - * Returns true if Polylang manages languages and translations for this post type | |
| 343 | + * Returns true if Polylang manages languages and translations for this post type. | |
| 255 | 344 | * |
| 256 | 345 | * @since 1.2 |
| 257 | 346 | * |
| 258 | - * @param string|array $post_type post type name or array of post type names | |
| 347 | + * @param string|string[] $post_type Post type name or array of post type names. | |
| 259 | 348 | * @return bool |
| 260 | 349 | */ |
| 261 | 350 | public function is_translated_post_type( $post_type ) { |
| 262 | - $post_types = $this->get_translated_post_types( false ); | |
| 263 | - return ( is_array( $post_type ) && array_intersect( $post_type, $post_types ) || in_array( $post_type, $post_types ) || 'any' === $post_type && ! empty( $post_types ) ); | |
| 351 | + if ( empty( array_filter( (array) $post_type ) ) ) { | |
| 352 | + return false; | |
| 353 | + } | |
| 354 | + | |
| 355 | + /** @var non-empty-array<non-empty-string>|non-empty-string $post_type */ | |
| 356 | + return $this->translatable_objects->get( 'post' )->is_translated_object_type( $post_type ); | |
| 264 | 357 | } |
| 265 | 358 | |
| 266 | 359 | /** |
| 267 | - * Return taxonomies that need to be translated | |
| 360 | + * Returns taxonomies that need to be translated. | |
| 361 | + * The taxonomies list is cached for better better performance. | |
| 362 | + * The method waits for 'after_setup_theme' to apply the cache | |
| 363 | + * to allow themes adding the filter in functions.php. | |
| 268 | 364 | * |
| 269 | 365 | * @since 1.2 |
| 270 | 366 | * |
| 271 | - * @param bool $filter true if we should return only valid registered taxonomies | |
| 272 | - * @return array array of registered taxonomy names for which Polylang manages languages and translations | |
| 367 | + * @param bool $filter True if we should return only valid registered taxonomies. | |
| 368 | + * @return string[] Array of registered taxonomy names for which Polylang manages languages and translations. | |
| 273 | 369 | */ |
| 274 | 370 | public function get_translated_taxonomies( $filter = true ) { |
| 275 | - if ( false === $taxonomies = $this->cache->get( 'taxonomies' ) ) { | |
| 276 | - $taxonomies = array( 'category' => 'category', 'post_tag' => 'post_tag' ); | |
| 277 | - | |
| 278 | - if ( ! empty( $this->options['taxonomies'] ) && is_array( $this->options['taxonomies'] ) ) { | |
| 279 | - $taxonomies = array_merge( $taxonomies, array_combine( $this->options['taxonomies'], $this->options['taxonomies'] ) ); | |
| 280 | - } | |
| 281 | - | |
| 282 | - /** | |
| 283 | - * Filter the list of taxonomies available for translation. | |
| 284 | - * The default are taxonomies which have the parameter ‘public’ set to true. | |
| 285 | - * The filter must be added soon in the WordPress loading process: | |
| 286 | - * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. | |
| 287 | - * | |
| 288 | - * @since 0.8 | |
| 289 | - * | |
| 290 | - * @param array $taxonomies list of taxonomy names | |
| 291 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 292 | - */ | |
| 293 | - $taxonomies = apply_filters( 'pll_get_taxonomies', $taxonomies, false ); | |
| 294 | - if ( did_action( 'after_setup_theme' ) ) { | |
| 295 | - $this->cache->set( 'taxonomies', $taxonomies ); | |
| 296 | - } | |
| 297 | - } | |
| 298 | - | |
| 299 | - return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; | |
| 371 | + return $this->translatable_objects->get( 'term' )->get_translated_object_types( $filter ); | |
| 300 | 372 | } |
| 301 | 373 | |
| 302 | 374 | /** |
| 303 | - * Returns true if Polylang manages languages and translations for this taxonomy | |
| 375 | + * Returns true if Polylang manages languages and translations for this taxonomy. | |
| 304 | 376 | * |
| 305 | 377 | * @since 1.2 |
| 306 | 378 | * |
| 307 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 379 | + * @param string|string[] $tax Taxonomy name or array of taxonomy names. | |
| 308 | 380 | * @return bool |
| 309 | 381 | */ |
| 310 | 382 | public function is_translated_taxonomy( $tax ) { |
| 311 | - $taxonomies = $this->get_translated_taxonomies( false ); | |
| 312 | - return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); | |
| 383 | + if ( empty( array_filter( (array) $tax ) ) ) { | |
| 384 | + return false; | |
| 385 | + } | |
| 386 | + | |
| 387 | + /** @var non-empty-array<non-empty-string>|non-empty-string $tax */ | |
| 388 | + return $this->translatable_objects->get( 'term' )->is_translated_object_type( $tax ); | |
| 313 | 389 | } |
| 314 | 390 | |
| 315 | 391 | /** |
| 316 | - * Return taxonomies that need to be filtered ( post_format like ) | |
| 392 | + * Return taxonomies that need to be filtered (post_format like). | |
| 317 | 393 | * |
| 318 | 394 | * @since 1.7 |
| 319 | 395 | * |
| 320 | - * @param bool $filter true if we should return only valid registered taxonomies | |
| 321 | - * @return array array of registered taxonomy names | |
| 396 | + * @param bool $filter True if we should return only valid registered taxonomies. | |
| 397 | + * @return string[] Array of registered taxonomy names. | |
| 322 | 398 | */ |
| 323 | 399 | public function get_filtered_taxonomies( $filter = true ) { |
| 324 | 400 | if ( did_action( 'after_setup_theme' ) ) { |
| 325 | 401 | static $taxonomies = null; |
| @@ -328,9 +404,9 @@ | ||
| 328 | 404 | if ( empty( $taxonomies ) ) { |
| 329 | 405 | $taxonomies = array( 'post_format' => 'post_format' ); |
| 330 | 406 | |
| 331 | 407 | /** |
| 332 | - * Filter the list of taxonomies not translatable but filtered by language. | |
| 408 | + * Filters the list of taxonomies not translatable but filtered by language. | |
| 333 | 409 | * Includes only the post format by default |
| 334 | 410 | * The filter must be added soon in the WordPress loading process: |
| 335 | 411 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 336 | 412 | * |
| @@ -335,10 +411,10 @@ | ||
| 335 | 411 | * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. |
| 336 | 412 | * |
| 337 | 413 | * @since 1.7 |
| 338 | 414 | * |
| 339 | - * @param array $taxonomies list of taxonomy names | |
| 340 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 415 | + * @param string[] $taxonomies List of taxonomy names. | |
| 416 | + * @param bool $is_settings True when displaying the list of custom taxonomies in Polylang settings. | |
| 341 | 417 | */ |
| 342 | 418 | $taxonomies = apply_filters( 'pll_filtered_taxonomies', $taxonomies, false ); |
| 343 | 419 | } |
| 344 | 420 | |
| @@ -345,13 +421,13 @@ | ||
| 345 | 421 | return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; |
| 346 | 422 | } |
| 347 | 423 | |
| 348 | 424 | /** |
| 349 | - * Returns true if Polylang filters this taxonomy per language | |
| 425 | + * Returns true if Polylang filters this taxonomy per language. | |
| 350 | 426 | * |
| 351 | 427 | * @since 1.7 |
| 352 | 428 | * |
| 353 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 429 | + * @param string|string[] $tax Taxonomy name or array of taxonomy names. | |
| 354 | 430 | * @return bool |
| 355 | 431 | */ |
| 356 | 432 | public function is_filtered_taxonomy( $tax ) { |
| 357 | 433 | $taxonomies = $this->get_filtered_taxonomies( false ); |
| @@ -358,85 +434,96 @@ | ||
| 358 | 434 | return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); |
| 359 | 435 | } |
| 360 | 436 | |
| 361 | 437 | /** |
| 362 | - * Returns the query vars of all filtered taxonomies | |
| 438 | + * Returns the query vars of all filtered taxonomies. | |
| 363 | 439 | * |
| 364 | 440 | * @since 1.7 |
| 365 | 441 | * |
| 366 | - * @return array | |
| 442 | + * @return string[] | |
| 367 | 443 | */ |
| 368 | 444 | public function get_filtered_taxonomies_query_vars() { |
| 369 | 445 | $query_vars = array(); |
| 370 | 446 | foreach ( $this->get_filtered_taxonomies() as $filtered_tax ) { |
| 371 | 447 | $tax = get_taxonomy( $filtered_tax ); |
| 372 | - $query_vars[] = $tax->query_var; | |
| 448 | + if ( ! empty( $tax ) && is_string( $tax->query_var ) ) { | |
| 449 | + $query_vars[] = $tax->query_var; | |
| 450 | + } | |
| 373 | 451 | } |
| 374 | 452 | return $query_vars; |
| 375 | 453 | } |
| 376 | 454 | |
| 377 | 455 | /** |
| 378 | - * Create a default category for a language | |
| 456 | + * It is possible to have several terms with the same name in the same taxonomy ( one per language ) | |
| 457 | + * but the native term_exists() will return true even if only one exists. | |
| 458 | + * So here the function adds the language parameter. | |
| 379 | 459 | * |
| 380 | - * @since 1.2 | |
| 460 | + * @since 1.4 | |
| 381 | 461 | * |
| 382 | - * @param object|string|int $lang language | |
| 462 | + * @param string $term_name The term name. | |
| 463 | + * @param string $taxonomy Taxonomy name. | |
| 464 | + * @param int $parent Parent term id. | |
| 465 | + * @param string|PLL_Language $language The language slug or object. | |
| 466 | + * @return int The `term_id` of the found term. 0 otherwise. | |
| 467 | + * | |
| 468 | + * @phpstan-return int<0, max> | |
| 383 | 469 | */ |
| 384 | - public function create_default_category( $lang ) { | |
| 385 | - $lang = $this->get_language( $lang ); | |
| 470 | + public function term_exists( $term_name, $taxonomy, $parent, $language ) { | |
| 471 | + global $wpdb; | |
| 386 | 472 | |
| 387 | - // create a new category | |
| 388 | - // FIXME this is translated in admin language when we would like it in $lang | |
| 389 | - $cat_name = __( 'Uncategorized', 'polylang' ); | |
| 390 | - $cat_slug = sanitize_title( $cat_name . '-' . $lang->slug ); | |
| 391 | - $cat = wp_insert_term( $cat_name, 'category', array( 'slug' => $cat_slug ) ); | |
| 473 | + $language = $this->get_language( $language ); | |
| 474 | + if ( empty( $language ) ) { | |
| 475 | + return 0; | |
| 476 | + } | |
| 392 | 477 | |
| 393 | - // check that the category was not previously created ( in case the language was deleted and recreated ) | |
| 394 | - $cat = isset( $cat->error_data['term_exists'] ) ? $cat->error_data['term_exists'] : $cat['term_id']; | |
| 478 | + $term_name = trim( wp_unslash( $term_name ) ); | |
| 479 | + $term_name = _wp_specialchars( $term_name ); | |
| 395 | 480 | |
| 396 | - // set language | |
| 397 | - $this->term->set_language( (int) $cat, $lang ); | |
| 481 | + $select = "SELECT t.term_id FROM $wpdb->terms AS t"; | |
| 482 | + $join = " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id"; | |
| 483 | + $join .= $this->term->join_clause(); | |
| 484 | + $where = $wpdb->prepare( ' WHERE tt.taxonomy = %s AND t.name = %s', $taxonomy, $term_name ); | |
| 485 | + $where .= $this->term->where_clause( $language ); | |
| 398 | 486 | |
| 399 | - // this is a translation of the default category | |
| 400 | - $default = (int) get_option( 'default_category' ); | |
| 401 | - $translations = $this->term->get_translations( $default ); | |
| 402 | - if ( empty( $translations ) ) { | |
| 403 | - if ( $lg = $this->term->get_language( $default ) ) { | |
| 404 | - $translations[ $lg->slug ] = $default; | |
| 405 | - } | |
| 406 | - else { | |
| 407 | - $translations = array(); | |
| 408 | - } | |
| 487 | + if ( $parent > 0 ) { | |
| 488 | + $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent ); | |
| 409 | 489 | } |
| 410 | 490 | |
| 411 | - $this->term->save_translations( (int) $cat, $translations ); | |
| 491 | + // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared | |
| 492 | + $term_id = $wpdb->get_var( $select . $join . $where ); | |
| 493 | + return max( 0, (int) $term_id ); | |
| 412 | 494 | } |
| 413 | 495 | |
| 414 | 496 | /** |
| 415 | - * It is possible to have several terms with the same name in the same taxonomy ( one per language ) | |
| 416 | - * but the native term_exists will return true even if only one exists | |
| 417 | - * so here the function adds the language parameter | |
| 497 | + * Checks if a term slug exists in a given language, taxonomy, hierarchy. | |
| 418 | 498 | * |
| 419 | - * @since 1.4 | |
| 499 | + * @since 1.9 | |
| 500 | + * @since 2.8 Moved from PLL_Share_Term_Slug::term_exists() to PLL_Model::term_exists_by_slug(). | |
| 420 | 501 | * |
| 421 | - * @param string $term_name the term name | |
| 422 | - * @param string $taxonomy taxonomy name | |
| 423 | - * @param int $parent parent term id | |
| 424 | - * @param string|object $language the language slug or object | |
| 425 | - * @return null|int the term_id of the found term | |
| 502 | + * @param string $slug The term slug to test. | |
| 503 | + * @param string|PLL_Language $language The language slug or object. | |
| 504 | + * @param string $taxonomy Optional taxonomy name. | |
| 505 | + * @param int $parent Optional parent term id. | |
| 506 | + * @return int The `term_id` of the found term. 0 otherwise. | |
| 426 | 507 | */ |
| 427 | - public function term_exists( $term_name, $taxonomy, $parent, $language ) { | |
| 508 | + public function term_exists_by_slug( $slug, $language, $taxonomy = '', $parent = 0 ) { | |
| 428 | 509 | global $wpdb; |
| 429 | 510 | |
| 430 | - $term_name = trim( wp_unslash( $term_name ) ); | |
| 431 | - $term_name = _wp_specialchars( $term_name ); | |
| 511 | + $language = $this->get_language( $language ); | |
| 512 | + if ( empty( $language ) ) { | |
| 513 | + return 0; | |
| 514 | + } | |
| 432 | 515 | |
| 433 | - $select = "SELECT t.term_id FROM $wpdb->terms AS t"; | |
| 434 | - $join = " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id"; | |
| 435 | - $join .= $this->term->join_clause(); | |
| 436 | - $where = $wpdb->prepare( ' WHERE tt.taxonomy = %s AND t.name = %s', $taxonomy, $term_name ); | |
| 437 | - $where .= $this->term->where_clause( $this->get_language( $language ) ); | |
| 516 | + $select = "SELECT t.term_id FROM {$wpdb->terms} AS t"; | |
| 517 | + $join = " INNER JOIN {$wpdb->term_taxonomy} AS tt ON t.term_id = tt.term_id"; | |
| 518 | + $join .= $this->term->join_clause(); | |
| 519 | + $where = $wpdb->prepare( ' WHERE t.slug = %s', $slug ); | |
| 520 | + $where .= $this->term->where_clause( $language ); | |
| 438 | 521 | |
| 522 | + if ( ! empty( $taxonomy ) ) { | |
| 523 | + $where .= $wpdb->prepare( ' AND tt.taxonomy = %s', $taxonomy ); | |
| 524 | + } | |
| 525 | + | |
| 439 | 526 | if ( $parent > 0 ) { |
| 440 | 527 | $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent ); |
| 441 | 528 | } |
| 442 | 529 | |
| @@ -443,21 +530,47 @@ | ||
| 443 | 530 | // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared |
| 444 | 531 | return $wpdb->get_var( $select . $join . $where ); |
| 445 | 532 | } |
| 446 | 533 | |
| 534 | + | |
| 447 | 535 | /** |
| 448 | - * Gets the number of posts per language in a date, author or post type archive. | |
| 536 | + * Returns the number of posts per language in a date, author or post type archive. | |
| 449 | 537 | * |
| 450 | 538 | * @since 1.2 |
| 451 | 539 | * |
| 452 | - * @param object $lang PLL_Language instance. | |
| 453 | - * @param array $q WP_Query arguments ( accepted: post_type, m, year, monthnum, day, author, author_name, post_format, post_status ). | |
| 540 | + * @param PLL_Language $lang PLL_Language instance. | |
| 541 | + * @param array $q { | |
| 542 | + * WP_Query arguments: | |
| 543 | + * | |
| 544 | + * @type string|string[] $post_type Post type or array of post types. | |
| 545 | + * @type int $m Combination YearMonth. Accepts any four-digit year and month. | |
| 546 | + * @type int $year Four-digit year. | |
| 547 | + * @type int $monthnum Two-digit month. | |
| 548 | + * @type int $day Day of the month. | |
| 549 | + * @type int $author Author id. | |
| 550 | + * @type string $author_name User 'user_nicename'. | |
| 551 | + * @type string $post_format Post format. | |
| 552 | + * @type string $post_status Post status. | |
| 553 | + * } | |
| 454 | 554 | * @return int |
| 555 | + * | |
| 556 | + * @phpstan-param array{ | |
| 557 | + * post_type?: non-falsy-string|array<non-falsy-string>, | |
| 558 | + * post_status?: non-falsy-string, | |
| 559 | + * m?: numeric-string, | |
| 560 | + * year?: positive-int, | |
| 561 | + * monthnum?: int<1, 12>, | |
| 562 | + * day?: int<1, 31>, | |
| 563 | + * author?: int<1, max>, | |
| 564 | + * author_name?: non-falsy-string, | |
| 565 | + * post_format?: non-falsy-string | |
| 566 | + * } $q | |
| 567 | + * @phpstan-return int<0, max> | |
| 455 | 568 | */ |
| 456 | 569 | public function count_posts( $lang, $q = array() ) { |
| 457 | 570 | global $wpdb; |
| 458 | 571 | |
| 459 | - $q = wp_parse_args( $q, array( 'post_type' => 'post', 'post_status' => 'publish' ) ); | |
| 572 | + $q = array_merge( array( 'post_type' => 'post', 'post_status' => 'publish' ), $q ); | |
| 460 | 573 | |
| 461 | 574 | if ( ! is_array( $q['post_type'] ) ) { |
| 462 | 575 | $q['post_type'] = array( $q['post_type'] ); |
| 463 | 576 | } |
| @@ -471,17 +584,18 @@ | ||
| 471 | 584 | if ( empty( $q['post_type'] ) ) { |
| 472 | 585 | $q['post_type'] = array( 'post' ); // We *need* a post type. |
| 473 | 586 | } |
| 474 | 587 | |
| 475 | - $cache_key = 'pll_count_posts_' . md5( maybe_serialize( $q ) ); | |
| 476 | - $counts = wp_cache_get( $cache_key, 'counts' ); | |
| 588 | + $cache_key = $this->cache->get_unique_key( 'pll_count_posts_', $q ); | |
| 589 | + $counts = wp_cache_get( $cache_key, 'counts' ); | |
| 477 | 590 | |
| 478 | - if ( false === $counts ) { | |
| 479 | - $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts}"; | |
| 480 | - $join = $this->post->join_clause(); | |
| 481 | - $where = sprintf( " WHERE post_status = '%s'", esc_sql( $q['post_status'] ) ); | |
| 482 | - $where .= sprintf( " AND {$wpdb->posts}.post_type IN ( '%s' )", join( "', '", esc_sql( $q['post_type'] ) ) ); | |
| 483 | - $where .= $this->post->where_clause( $this->get_languages_list() ); | |
| 591 | + if ( ! is_array( $counts ) ) { | |
| 592 | + $counts = array(); | |
| 593 | + $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts}"; | |
| 594 | + $join = $this->post->join_clause(); | |
| 595 | + $where = sprintf( " WHERE post_status = '%s'", esc_sql( $q['post_status'] ) ); | |
| 596 | + $where .= sprintf( " AND {$wpdb->posts}.post_type IN ( '%s' )", implode( "', '", esc_sql( $q['post_type'] ) ) ); | |
| 597 | + $where .= $this->post->where_clause( $this->get_languages_list() ); | |
| 484 | 598 | $groupby = ' GROUP BY pll_tr.term_taxonomy_id'; |
| 485 | 599 | |
| 486 | 600 | if ( ! empty( $q['m'] ) ) { |
| 487 | 601 | $q['m'] = '' . preg_replace( '|[^0-9]|', '', $q['m'] ); |
| @@ -536,17 +650,18 @@ | ||
| 536 | 650 | |
| 537 | 651 | wp_cache_set( $cache_key, $counts, 'counts' ); |
| 538 | 652 | } |
| 539 | 653 | |
| 540 | - return empty( $counts[ $lang->term_taxonomy_id ] ) ? 0 : $counts[ $lang->term_taxonomy_id ]; | |
| 654 | + $term_taxonomy_id = $lang->get_tax_prop( 'language', 'term_taxonomy_id' ); | |
| 655 | + return empty( $counts[ $term_taxonomy_id ] ) ? 0 : $counts[ $term_taxonomy_id ]; | |
| 541 | 656 | } |
| 542 | 657 | |
| 543 | 658 | /** |
| 544 | - * Setup the links model based on options | |
| 659 | + * Setup the links model based on options. | |
| 545 | 660 | * |
| 546 | 661 | * @since 1.2 |
| 547 | 662 | * |
| 548 | - * @return object implementing "links_model interface" | |
| 663 | + * @return PLL_Links_Model | |
| 549 | 664 | */ |
| 550 | 665 | public function get_links_model() { |
| 551 | 666 | $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' ); |
| 552 | 667 | $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default'; |
| @@ -551,14 +666,14 @@ | ||
| 551 | 666 | $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' ); |
| 552 | 667 | $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default'; |
| 553 | 668 | |
| 554 | 669 | /** |
| 555 | - * Filter the links model class to use | |
| 556 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 670 | + * Filters the links model class to use. | |
| 671 | + * /!\ this filter is fired *before* the $polylang object is available. | |
| 557 | 672 | * |
| 558 | 673 | * @since 2.1.1 |
| 559 | 674 | * |
| 560 | - * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain | |
| 675 | + * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain. | |
| 561 | 676 | */ |
| 562 | 677 | $class = apply_filters( 'pll_links_model', $class ); |
| 563 | 678 | |
| 564 | 679 | return new $class( $this ); |
| @@ -564,80 +679,372 @@ | ||
| 564 | 679 | return new $class( $this ); |
| 565 | 680 | } |
| 566 | 681 | |
| 567 | 682 | /** |
| 568 | - * Some backward compatibility with Polylang < 1.8 | |
| 569 | - * allows for example to call $polylang->model->get_post_languages( $post_id ) instead of $polylang->model->post->get_language( $post_id ) | |
| 570 | - * this works but should be slower than the direct call, thus an error is triggered in debug mode | |
| 683 | + * Returns a list of object IDs without language (used in settings and wizard). | |
| 571 | 684 | * |
| 572 | - * @since 1.8 | |
| 685 | + * @since 0.9 | |
| 686 | + * @since 2.2.6 Added the `$limit` parameter. | |
| 687 | + * @since 3.4 Added the `$types` parameter. | |
| 573 | 688 | * |
| 574 | - * @param string $func Function name | |
| 575 | - * @param array $args Function arguments | |
| 689 | + * @param int $limit Optional. Max number of IDs to return. Defaults to -1 (no limit). | |
| 690 | + * @param string[] $types Optional. Types to handle (@see PLL_Translatable_Object::get_type()). Defaults to | |
| 691 | + * an empty array (all types). | |
| 692 | + * @return int[][]|false { | |
| 693 | + * IDs of objects without language. | |
| 694 | + * | |
| 695 | + * @type int[] $posts Array of post ids. | |
| 696 | + * @type int[] $terms Array of term ids. | |
| 697 | + * } | |
| 698 | + * | |
| 699 | + * @phpstan-param -1|positive-int $limit | |
| 576 | 700 | */ |
| 577 | - public function __call( $func, $args ) { | |
| 578 | - $f = $func; | |
| 701 | + public function get_objects_with_no_lang( $limit = -1, array $types = array() ) { | |
| 702 | + /** | |
| 703 | + * Filters the max number of IDs to return when searching objects with no language. | |
| 704 | + * This filter can be used to decrease the memory usage in case the number of objects | |
| 705 | + * without language is too big. Using a negative value is equivalent to have no limit. | |
| 706 | + * | |
| 707 | + * @since 2.2.6 | |
| 708 | + * @since 3.4 Added the `$types` parameter. | |
| 709 | + * | |
| 710 | + * @param int $limit Max number of IDs to retrieve from the database. | |
| 711 | + * @param string[] $types Types to handle (@see PLL_Translatable_Object::get_type()). An empty array means all | |
| 712 | + * types. | |
| 713 | + */ | |
| 714 | + $limit = apply_filters( 'get_objects_with_no_lang_limit', $limit, $types ); | |
| 715 | + $limit = $limit < 1 ? -1 : max( (int) $limit, 1 ); | |
| 716 | + $objects = array(); | |
| 579 | 717 | |
| 580 | - switch ( $func ) { | |
| 581 | - case 'get_object_term': | |
| 582 | - $o = ( false === strpos( $args[1], 'term' ) ) ? 'post' : 'term'; | |
| 583 | - break; | |
| 718 | + foreach ( $this->translatable_objects as $type => $object ) { | |
| 719 | + if ( ! empty( $types ) && ! in_array( $type, $types, true ) ) { | |
| 720 | + continue; | |
| 721 | + } | |
| 584 | 722 | |
| 585 | - case 'save_translations': | |
| 586 | - case 'delete_translation': | |
| 587 | - case 'get_translations': | |
| 588 | - case 'get_translation': | |
| 589 | - case 'join_clause': | |
| 590 | - $o = ( 'post' == $args[0] || $this->is_translated_post_type( $args[0] ) ) ? 'post' : ( 'term' == $args[0] || $this->is_translated_taxonomy( $args[0] ) ? 'term' : false ); | |
| 591 | - unset( $args[0] ); | |
| 592 | - break; | |
| 723 | + $ids = $object->get_objects_with_no_lang( $limit ); | |
| 593 | 724 | |
| 594 | - case 'set_post_language': | |
| 595 | - case 'get_post_language': | |
| 596 | - case 'set_term_language': | |
| 597 | - case 'get_term_language': | |
| 598 | - case 'delete_term_language': | |
| 599 | - case 'get_post': | |
| 600 | - case 'get_term': | |
| 601 | - $str = explode( '_', $func ); | |
| 602 | - $f = empty( $str[2] ) ? $str[0] : $str[0] . '_' . $str[2]; | |
| 603 | - $o = $str[1]; | |
| 604 | - break; | |
| 725 | + if ( empty( $ids ) ) { | |
| 726 | + continue; | |
| 727 | + } | |
| 605 | 728 | |
| 606 | - case 'where_clause': | |
| 607 | - case 'get_objects_in_language': | |
| 608 | - $o = $args[1]; | |
| 609 | - unset( $args[1] ); | |
| 610 | - break; | |
| 729 | + // The trailing 's' in the array key is for backward compatibility. | |
| 730 | + $objects[ "{$type}s" ] = $ids; | |
| 611 | 731 | } |
| 612 | 732 | |
| 613 | - if ( ! empty( $o ) && is_object( $this->$o ) && method_exists( $this->$o, $f ) ) { | |
| 614 | - if ( WP_DEBUG ) { | |
| 615 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 616 | - $i = 1 + empty( $debug[1]['line'] ); // the file and line are in $debug[2] if the function was called using call_user_func | |
| 733 | + $objects = ! empty( $objects ) ? $objects : false; | |
| 617 | 734 | |
| 618 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 619 | - sprintf( | |
| 620 | - '%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", | |
| 621 | - esc_html( $func ), | |
| 622 | - esc_html( $o ), | |
| 623 | - esc_html( $f ), | |
| 624 | - esc_html( $debug[ $i ]['file'] ), | |
| 625 | - absint( $debug[ $i ]['line'] ) | |
| 626 | - ) | |
| 627 | - ); | |
| 735 | + /** | |
| 736 | + * Filters the list of IDs of untranslated objects. | |
| 737 | + * | |
| 738 | + * @since 0.9 | |
| 739 | + * @since 3.4 Added the `$limit` and `$types` parameters. | |
| 740 | + * | |
| 741 | + * @param int[][]|false $objects List of lists of object IDs, `false` if no IDs found. | |
| 742 | + * @param int $limit Max number of IDs to retrieve from the database. | |
| 743 | + * @param string[] $types Types to handle (@see PLL_Translatable_Object::get_type()). An empty array | |
| 744 | + * means all types. | |
| 745 | + */ | |
| 746 | + return apply_filters( 'pll_get_objects_with_no_lang', $objects, $limit, $types ); | |
| 747 | + } | |
| 748 | + | |
| 749 | + /** | |
| 750 | + * Returns ids of post without language. | |
| 751 | + * | |
| 752 | + * @since 3.1 | |
| 753 | + * | |
| 754 | + * @param string|string[] $post_types A translated post type or an array of translated post types. | |
| 755 | + * @param int $limit Max number of objects to return. `-1` to return all of them. | |
| 756 | + * @return int[] | |
| 757 | + * | |
| 758 | + * @phpstan-param -1|positive-int $limit | |
| 759 | + * @phpstan-return list<positive-int> | |
| 760 | + */ | |
| 761 | + public function get_posts_with_no_lang( $post_types, $limit ) { | |
| 762 | + return $this->translatable_objects->get( 'post' )->get_objects_with_no_lang( $limit, (array) $post_types ); | |
| 763 | + } | |
| 764 | + | |
| 765 | + /** | |
| 766 | + * Returns ids of terms without language. | |
| 767 | + * | |
| 768 | + * @since 3.1 | |
| 769 | + * | |
| 770 | + * @param string|string[] $taxonomies A translated taxonomy or an array of taxonomies post types. | |
| 771 | + * @param int $limit Max number of objects to return. `-1` to return all of them. | |
| 772 | + * @return int[] | |
| 773 | + * | |
| 774 | + * @phpstan-param -1|positive-int $limit | |
| 775 | + * @phpstan-return list<positive-int> | |
| 776 | + */ | |
| 777 | + public function get_terms_with_no_lang( $taxonomies, $limit ) { | |
| 778 | + return $this->translatable_objects->get( 'term' )->get_objects_with_no_lang( $limit, (array) $taxonomies ); | |
| 779 | + } | |
| 780 | + | |
| 781 | + /** | |
| 782 | + * Assigns the default language to objects in mass. | |
| 783 | + * | |
| 784 | + * @since 1.2 | |
| 785 | + * @since 3.4 Moved from PLL_Admin_Model class. | |
| 786 | + * Removed `$limit` parameter, added `$lang` and `$types` parameters. | |
| 787 | + * | |
| 788 | + * @param PLL_Language|null $lang Optional. The language to assign to objects. Defaults to `null` (default language). | |
| 789 | + * @param string[] $types Optional. Types to handle (@see PLL_Translatable_Object::get_type()). Defaults | |
| 790 | + * to an empty array (all types). | |
| 791 | + * @return void | |
| 792 | + */ | |
| 793 | + public function set_language_in_mass( $lang = null, array $types = array() ) { | |
| 794 | + if ( ! $lang instanceof PLL_Language ) { | |
| 795 | + $lang = $this->get_default_language(); | |
| 796 | + | |
| 797 | + if ( empty( $lang ) ) { | |
| 798 | + return; | |
| 628 | 799 | } |
| 629 | - return call_user_func_array( array( $this->$o, $f ), $args ); | |
| 630 | 800 | } |
| 631 | 801 | |
| 632 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 633 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 634 | - sprintf( | |
| 635 | - 'Call to undefined function PLL()->model->%1$s() in %2$s on line %3$s' . "\nError handler", | |
| 636 | - esc_html( $func ), | |
| 637 | - esc_html( $debug[0]['file'] ), | |
| 638 | - absint( $debug[0]['line'] ) | |
| 639 | - ), | |
| 640 | - E_USER_ERROR | |
| 802 | + // 1000 is an arbitrary value that will be filtered by `get_objects_with_no_lang_limit`. | |
| 803 | + $nolang = $this->get_objects_with_no_lang( 1000, $types ); | |
| 804 | + | |
| 805 | + if ( empty( $nolang ) ) { | |
| 806 | + return; | |
| 807 | + } | |
| 808 | + | |
| 809 | + /** | |
| 810 | + * Keep track of types where we set the language: | |
| 811 | + * those are types where we may have more items to process if we have more than 1000 items in total. | |
| 812 | + * This will prevent unnecessary SQL queries in the next recursion: if we have 0 items in this recursion for | |
| 813 | + * a type, we'll still have 0 in the next one, no need for a new query. | |
| 814 | + */ | |
| 815 | + $types_with_objects = array(); | |
| 816 | + | |
| 817 | + foreach ( $this->translatable_objects as $type => $object ) { | |
| 818 | + if ( empty( $nolang[ "{$type}s" ] ) ) { | |
| 819 | + continue; | |
| 820 | + } | |
| 821 | + | |
| 822 | + if ( ! empty( $types ) && ! in_array( $type, $types, true ) ) { | |
| 823 | + continue; | |
| 824 | + } | |
| 825 | + | |
| 826 | + $object->set_language_in_mass( $nolang[ "{$type}s" ], $lang ); | |
| 827 | + $types_with_objects[] = $type; | |
| 828 | + } | |
| 829 | + | |
| 830 | + if ( empty( $types_with_objects ) ) { | |
| 831 | + return; | |
| 832 | + } | |
| 833 | + | |
| 834 | + $this->set_language_in_mass( $lang, $types_with_objects ); | |
| 835 | + } | |
| 836 | + | |
| 837 | + /** | |
| 838 | + * Filters the ORDERBY clause of the languages query. | |
| 839 | + * | |
| 840 | + * This allows to order languages terms by `taxonomy` first then by `term_group` and `term_id`. | |
| 841 | + * Ordering terms by taxonomy allows not to mix terms between all language taxomonomies. | |
| 842 | + * Having the "language' taxonomy first is important for {@see PLL_Admin_Model:delete_language()}. | |
| 843 | + * | |
| 844 | + * @since 3.2.3 | |
| 845 | + * | |
| 846 | + * @param string $orderby `ORDERBY` clause of the terms query. | |
| 847 | + * @param array $args An array of term query arguments. | |
| 848 | + * @param string[] $taxonomies An array of taxonomy names. | |
| 849 | + * @return string | |
| 850 | + */ | |
| 851 | + public function filter_language_terms_orderby( $orderby, $args, $taxonomies ) { | |
| 852 | + $allowed_taxonomies = $this->translatable_objects->get_taxonomy_names( array( 'language' ) ); | |
| 853 | + | |
| 854 | + if ( ! is_array( $taxonomies ) || ! empty( array_diff( $taxonomies, $allowed_taxonomies ) ) ) { | |
| 855 | + return $orderby; | |
| 856 | + } | |
| 857 | + | |
| 858 | + if ( empty( $orderby ) || ! is_string( $orderby ) ) { | |
| 859 | + return $orderby; | |
| 860 | + } | |
| 861 | + | |
| 862 | + if ( ! preg_match( '@^(?<alias>[^.]+)\.term_group$@', $orderby, $matches ) ) { | |
| 863 | + return $orderby; | |
| 864 | + } | |
| 865 | + | |
| 866 | + return sprintf( 'tt.taxonomy = \'language\' DESC, %1$s.term_group, %1$s.term_id', $matches['alias'] ); | |
| 867 | + } | |
| 868 | + | |
| 869 | + /** | |
| 870 | + * Maybe adds the missing language terms for 3rd party language taxonomies. | |
| 871 | + * | |
| 872 | + * @since 3.4 | |
| 873 | + * | |
| 874 | + * @return void | |
| 875 | + */ | |
| 876 | + public function maybe_create_language_terms() { | |
| 877 | + $registered_taxonomies = array_diff( | |
| 878 | + $this->translatable_objects->get_taxonomy_names( array( 'language' ) ), | |
| 879 | + // Exclude the post and term language taxonomies from the list. | |
| 880 | + array( $this->post->get_tax_language(), $this->term->get_tax_language() ) | |
| 641 | 881 | ); |
| 882 | + | |
| 883 | + if ( empty( $registered_taxonomies ) ) { | |
| 884 | + // No 3rd party language taxonomies. | |
| 885 | + return; | |
| 886 | + } | |
| 887 | + | |
| 888 | + // We have at least one 3rd party language taxonomy. | |
| 889 | + $known_taxonomies = ! empty( $this->options['language_taxonomies'] ) && is_array( $this->options['language_taxonomies'] ) ? $this->options['language_taxonomies'] : array(); | |
| 890 | + $new_taxonomies = array_diff( $registered_taxonomies, $known_taxonomies ); | |
| 891 | + | |
| 892 | + if ( empty( $new_taxonomies ) ) { | |
| 893 | + // No new 3rd party language taxonomies. | |
| 894 | + return; | |
| 895 | + } | |
| 896 | + | |
| 897 | + // We have at least one unknown 3rd party language taxonomy. | |
| 898 | + foreach ( $this->get_languages_list() as $language ) { | |
| 899 | + $this->update_secondary_language_terms( $language->slug, $language->name, $language, $new_taxonomies ); | |
| 900 | + } | |
| 901 | + | |
| 902 | + // Clear the cache, so the new `term_id` and `term_taxonomy_id` appear in the languages list. | |
| 903 | + $this->clean_languages_cache(); | |
| 904 | + | |
| 905 | + // Keep the previous values, so this is triggered only once per taxonomy. | |
| 906 | + $this->options['language_taxonomies'] = array_merge( $known_taxonomies, $new_taxonomies ); | |
| 907 | + update_option( 'polylang', $this->options ); | |
| 908 | + } | |
| 909 | + | |
| 910 | + /** | |
| 911 | + * Updates or adds new terms for a secondary language taxonomy (aka not 'language'). | |
| 912 | + * | |
| 913 | + * @since 3.4 | |
| 914 | + * | |
| 915 | + * @param string $slug Language term slug (with or without the `pll_` prefix). | |
| 916 | + * @param string $name Language name (label). | |
| 917 | + * @param PLL_Language|null $language Optional. A language object. Required to update the existing terms. | |
| 918 | + * @param string[] $taxonomies Optional. List of language taxonomies to deal with. An empty value means | |
| 919 | + * all of them. Defaults to all taxonomies. | |
| 920 | + * @return void | |
| 921 | + * | |
| 922 | + * @phpstan-param non-empty-string $slug | |
| 923 | + * @phpstan-param non-empty-string $name | |
| 924 | + * @phpstan-param array<non-empty-string> $taxonomies | |
| 925 | + */ | |
| 926 | + protected function update_secondary_language_terms( $slug, $name, PLL_Language $language = null, array $taxonomies = array() ) { | |
| 927 | + $slug = 0 === strpos( $slug, 'pll_' ) ? $slug : "pll_$slug"; | |
| 928 | + | |
| 929 | + foreach ( $this->translatable_objects->get_secondary_translatable_objects() as $object ) { | |
| 930 | + if ( ! empty( $taxonomies ) && ! in_array( $object->get_tax_language(), $taxonomies, true ) ) { | |
| 931 | + // Not in the list. | |
| 932 | + continue; | |
| 933 | + } | |
| 934 | + | |
| 935 | + if ( ! empty( $language ) ) { | |
| 936 | + $term_id = $language->get_tax_prop( $object->get_tax_language(), 'term_id' ); | |
| 937 | + } else { | |
| 938 | + $term_id = 0; | |
| 939 | + } | |
| 940 | + | |
| 941 | + if ( empty( $term_id ) ) { | |
| 942 | + // Attempt to repair the language if a term has been deleted by a database cleaning tool. | |
| 943 | + wp_insert_term( $name, $object->get_tax_language(), array( 'slug' => $slug ) ); | |
| 944 | + continue; | |
| 945 | + } | |
| 946 | + | |
| 947 | + /** @var PLL_Language $language */ | |
| 948 | + if ( "pll_{$language->slug}" !== $slug || $language->name !== $name ) { | |
| 949 | + // Something has changed. | |
| 950 | + wp_update_term( $term_id, $object->get_tax_language(), array( 'slug' => $slug, 'name' => $name ) ); | |
| 951 | + } | |
| 952 | + } | |
| 953 | + } | |
| 954 | + | |
| 955 | + /** | |
| 956 | + * Returns the list of available languages, based on the language taxonomy terms. | |
| 957 | + * Stores the list in a db transient and in a `PLL_Cache` object. | |
| 958 | + * | |
| 959 | + * @since 3.4 | |
| 960 | + * | |
| 961 | + * @return PLL_Language[] An array of `PLL_Language` objects, array keys are the type. | |
| 962 | + * | |
| 963 | + * @phpstan-return list<PLL_Language> | |
| 964 | + */ | |
| 965 | + protected function get_languages_from_taxonomies() { | |
| 966 | + $terms_by_slug = array(); | |
| 967 | + | |
| 968 | + foreach ( $this->get_language_terms() as $term ) { | |
| 969 | + // Except for language taxonomy term slugs, remove 'pll_' prefix from the other language taxonomy term slugs. | |
| 970 | + $key = 'language' === $term->taxonomy ? $term->slug : substr( $term->slug, 4 ); | |
| 971 | + $terms_by_slug[ $key ][ $term->taxonomy ] = $term; | |
| 972 | + } | |
| 973 | + | |
| 974 | + /** | |
| 975 | + * @var ( | |
| 976 | + * array{ | |
| 977 | + * string: array{ | |
| 978 | + * language: WP_Term, | |
| 979 | + * }&array<non-empty-string, WP_Term> | |
| 980 | + * } | |
| 981 | + * ) $terms_by_slug | |
| 982 | + */ | |
| 983 | + $languages = array_filter( | |
| 984 | + array_map( | |
| 985 | + array( new PLL_Language_Factory( $this->options ), 'get_from_terms' ), | |
| 986 | + array_values( $terms_by_slug ) | |
| 987 | + ) | |
| 988 | + ); | |
| 989 | + | |
| 990 | + /** | |
| 991 | + * Filters the list of languages *before* it is stored in the persistent cache. | |
| 992 | + * /!\ This filter is fired *before* the $polylang object is available. | |
| 993 | + * | |
| 994 | + * @since 1.7.5 | |
| 995 | + * @since 3.4 Deprecated. | |
| 996 | + * @deprecated | |
| 997 | + * | |
| 998 | + * @param PLL_Language[] $languages The list of language objects. | |
| 999 | + * @param PLL_Model $model PLL_Model object. | |
| 1000 | + */ | |
| 1001 | + $languages = apply_filters_deprecated( 'pll_languages_list', array( $languages, $this ), '3.4', 'pll_additional_language_data' ); | |
| 1002 | + | |
| 1003 | + if ( ! $this->are_languages_ready() ) { | |
| 1004 | + // Do not cache an incomplete list. | |
| 1005 | + /** @var list<PLL_Language> $languages */ | |
| 1006 | + return $languages; | |
| 1007 | + } | |
| 1008 | + | |
| 1009 | + /** | |
| 1010 | + * Don't store directly objects as it badly break with some hosts ( GoDaddy ) due to race conditions when using object cache. | |
| 1011 | + * Thanks to captin411 for catching this! | |
| 1012 | + * | |
| 1013 | + * @see https://wordpress.org/support/topic/fatal-error-pll_model_languages_list?replies=8#post-6782255 | |
| 1014 | + */ | |
| 1015 | + $languages_data = array_map( | |
| 1016 | + function ( $language ) { | |
| 1017 | + return $language->to_array( 'db' ); | |
| 1018 | + }, | |
| 1019 | + $languages | |
| 1020 | + ); | |
| 1021 | + | |
| 1022 | + set_transient( 'pll_languages_list', $languages_data ); | |
| 1023 | + | |
| 1024 | + /** @var list<PLL_Language> $languages */ | |
| 1025 | + return $languages; | |
| 1026 | + } | |
| 1027 | + | |
| 1028 | + /** | |
| 1029 | + * Returns the list of existing language terms. | |
| 1030 | + * - Returns all terms, that are or not assigned to posts. | |
| 1031 | + * - Terms are ordered by `term_group` and `term_id` (see `PLL_Model->filter_language_terms_orderby()`). | |
| 1032 | + * | |
| 1033 | + * @since 3.2.3 | |
| 1034 | + * | |
| 1035 | + * @return WP_Term[] | |
| 1036 | + */ | |
| 1037 | + protected function get_language_terms() { | |
| 1038 | + add_filter( 'get_terms_orderby', array( $this, 'filter_language_terms_orderby' ), 10, 3 ); | |
| 1039 | + $terms = get_terms( | |
| 1040 | + array( | |
| 1041 | + 'taxonomy' => $this->translatable_objects->get_taxonomy_names( array( 'language' ) ), | |
| 1042 | + 'orderby' => 'term_group', | |
| 1043 | + 'hide_empty' => false, | |
| 1044 | + ) | |
| 1045 | + ); | |
| 1046 | + remove_filter( 'get_terms_orderby', array( $this, 'filter_language_terms_orderby' ) ); | |
| 1047 | + | |
| 1048 | + return empty( $terms ) || is_wp_error( $terms ) ? array() : $terms; | |
| 642 | 1049 | } |
| 643 | 1050 | } |
