| @@ -3,43 +3,129 @@ | ||
| 3 | 3 | * @package Polylang |
| 4 | 4 | */ |
| 5 | 5 | |
| 6 | 6 | /** |
| 7 | - * Setups the objects languages and translations model | |
| 7 | + * Setups the objects languages and translations model. | |
| 8 | 8 | * |
| 9 | 9 | * @since 1.8 |
| 10 | 10 | */ |
| 11 | 11 | abstract class PLL_Translated_Object { |
| 12 | + /** | |
| 13 | + * @var PLL_Model | |
| 14 | + */ | |
| 12 | 15 | public $model; |
| 13 | - protected $object_type, $type, $tax_language, $tax_translations, $tax_tt; | |
| 14 | 16 | |
| 15 | 17 | /** |
| 16 | - * Constructor | |
| 18 | + * Object type to use when registering the taxonomies. | |
| 19 | + * Left empty for posts. | |
| 17 | 20 | * |
| 21 | + * @var string|null | |
| 22 | + */ | |
| 23 | + protected $object_type; | |
| 24 | + | |
| 25 | + /** | |
| 26 | + * Object type to use when checking capabilities. | |
| 27 | + * | |
| 28 | + * @var string | |
| 29 | + */ | |
| 30 | + protected $type; | |
| 31 | + | |
| 32 | + /** | |
| 33 | + * Taxonomy name for the languages. | |
| 34 | + * | |
| 35 | + * @var string | |
| 36 | + */ | |
| 37 | + protected $tax_language; | |
| 38 | + | |
| 39 | + /** | |
| 40 | + * Taxonomy name for the translation groups. | |
| 41 | + * | |
| 42 | + * @var string | |
| 43 | + */ | |
| 44 | + protected $tax_translations; | |
| 45 | + | |
| 46 | + /** | |
| 47 | + * PLL_Language property name for the term_taxonomy id. | |
| 48 | + * | |
| 49 | + * @var string | |
| 50 | + */ | |
| 51 | + protected $tax_tt; | |
| 52 | + | |
| 53 | + /** | |
| 54 | + * Constructor. | |
| 55 | + * | |
| 18 | 56 | * @since 1.8 |
| 19 | 57 | * |
| 20 | - * @param object $model | |
| 58 | + * @param PLL_Model $model Instance of PLL_Model. | |
| 21 | 59 | */ |
| 22 | 60 | public function __construct( &$model ) { |
| 23 | 61 | $this->model = &$model; |
| 24 | 62 | |
| 25 | - // register our taxonomies as soon as possible | |
| 26 | - // this is early registration, not ready for rewrite rules as wp_rewrite will be setup later | |
| 63 | + /* | |
| 64 | + * Register our taxonomies as soon as possible. | |
| 65 | + * This is early registration, not ready for rewrite rules as $wp_rewrite will be setup later. | |
| 66 | + */ | |
| 27 | 67 | $args = array( 'label' => false, 'public' => false, 'query_var' => false, 'rewrite' => false, '_pll' => true ); |
| 28 | 68 | register_taxonomy( $this->tax_language, $this->object_type, $args ); |
| 29 | - $args['update_count_callback'] = '_update_generic_term_count'; // count *all* posts to avoid deleting in clean_translations_terms | |
| 69 | + $args['update_count_callback'] = '_update_generic_term_count'; // Count *all* objects to avoid deleting in clean_translations_terms. | |
| 30 | 70 | register_taxonomy( $this->tax_translations, $this->object_type, $args ); |
| 31 | 71 | } |
| 32 | 72 | |
| 33 | 73 | /** |
| 34 | - * Wrap wp_get_object_terms to cache it and return only one object | |
| 35 | - * inspired by the function get_the_terms | |
| 74 | + * Stores the language in the database. | |
| 36 | 75 | * |
| 76 | + * @since 0.6 | |
| 77 | + * | |
| 78 | + * @param int $id Object id. | |
| 79 | + * @param int|string|PLL_Language $lang Language (term_id or slug or object). | |
| 80 | + * @return void | |
| 81 | + */ | |
| 82 | + abstract public function set_language( $id, $lang ); | |
| 83 | + | |
| 84 | + /** | |
| 85 | + * Returns the language of an object. | |
| 86 | + * | |
| 87 | + * @since 0.1 | |
| 88 | + * | |
| 89 | + * @param int $id Object id. | |
| 90 | + * @return PLL_Language|false PLL_Language object, false if no language is associated to that object. | |
| 91 | + */ | |
| 92 | + abstract public function get_language( $id ); | |
| 93 | + | |
| 94 | + /** | |
| 95 | + * Assigns a new language to an object, taking care of the translations group. | |
| 96 | + * | |
| 97 | + * @since 3.1 | |
| 98 | + * | |
| 99 | + * @param int $id Object id. | |
| 100 | + * @param PLL_Language $lang New language to assign to the object. | |
| 101 | + * @return void | |
| 102 | + */ | |
| 103 | + public function update_language( $id, $lang ) { | |
| 104 | + if ( $this->get_language( $id ) === $lang ) { | |
| 105 | + return; | |
| 106 | + } | |
| 107 | + | |
| 108 | + $this->set_language( $id, $lang ); | |
| 109 | + | |
| 110 | + $translations = $this->get_translations( $id ); | |
| 111 | + | |
| 112 | + if ( $translations ) { | |
| 113 | + // Remove the post's former language from the new translations group. | |
| 114 | + $translations = array_diff( $translations, array( $id ) ); | |
| 115 | + $this->save_translations( $id, $translations ); | |
| 116 | + } | |
| 117 | + } | |
| 118 | + | |
| 119 | + /** | |
| 120 | + * Wrap wp_get_object_terms() to cache it and return only one object. | |
| 121 | + * inspired by the WordPress function get_the_terms(). | |
| 122 | + * | |
| 37 | 123 | * @since 1.2 |
| 38 | 124 | * |
| 39 | - * @param int $object_id post_id or term_id | |
| 40 | - * @param string $taxonomy Polylang taxonomy depending if we are looking for a post ( or term ) language ( or translation ) | |
| 41 | - * @return bool|object the term associated to the object in the requested taxonomy if exists, false otherwise | |
| 125 | + * @param int $object_id Object id ( typically a post_id or term_id ). | |
| 126 | + * @param string $taxonomy Polylang taxonomy depending if we are looking for a post ( or term ) language ( or translation ). | |
| 127 | + * @return WP_Term|false The term associated to the object in the requested taxonomy if it exists, false otherwise. | |
| 42 | 128 | */ |
| 43 | 129 | public function get_object_term( $object_id, $taxonomy ) { |
| 44 | 130 | if ( empty( $object_id ) || is_wp_error( $object_id ) ) { |
| 45 | 131 | return false; |
| @@ -53,22 +139,24 @@ | ||
| 53 | 139 | |
| 54 | 140 | $term = get_object_term_cache( $object_id, $taxonomy ); |
| 55 | 141 | |
| 56 | 142 | if ( false === $term ) { |
| 57 | - // query language and translations at the same time | |
| 143 | + // Query language and translations at the same time. | |
| 58 | 144 | $taxonomies = array( $this->tax_language, $this->tax_translations ); |
| 59 | 145 | |
| 60 | - // query terms | |
| 146 | + // Query terms. | |
| 61 | 147 | $terms = array(); |
| 62 | - foreach ( wp_get_object_terms( $object_id, $taxonomies, array( 'update_term_meta_cache' => false ) ) as $t ) { | |
| 63 | - $terms[ $t->taxonomy ] = $t; | |
| 64 | - if ( $t->taxonomy == $taxonomy ) { | |
| 65 | - $term = $t; | |
| 148 | + $object_terms = wp_get_object_terms( $object_id, $taxonomies, array( 'update_term_meta_cache' => false ) ); | |
| 149 | + if ( is_array( $object_terms ) ) { | |
| 150 | + foreach ( $object_terms as $t ) { | |
| 151 | + $terms[ $t->taxonomy ] = $t; | |
| 152 | + if ( $t->taxonomy == $taxonomy ) { | |
| 153 | + $term = $t; | |
| 154 | + } | |
| 66 | 155 | } |
| 67 | 156 | } |
| 68 | 157 | |
| 69 | - // store it the way WP wants it | |
| 70 | - // set an empty cache if no term found in the taxonomy | |
| 158 | + // Stores it the way WP expects it. Set an empty cache if no term was found in the taxonomy. | |
| 71 | 159 | foreach ( $taxonomies as $tax ) { |
| 72 | 160 | wp_cache_add( $object_id, empty( $terms[ $tax ] ) ? array() : array( $terms[ $tax ] ), $tax . '_relationships' ); |
| 73 | 161 | } |
| 74 | 162 | } |
| @@ -79,68 +167,72 @@ | ||
| 79 | 167 | return empty( $term ) ? false : $term; |
| 80 | 168 | } |
| 81 | 169 | |
| 82 | 170 | /** |
| 83 | - * Tells whether a translation term must be updated | |
| 171 | + * Tells whether a translation term must be updated. | |
| 84 | 172 | * |
| 85 | 173 | * @since 2.3 |
| 86 | 174 | * |
| 87 | - * @param array $id Post id or term id | |
| 88 | - * @param array $translations An associative array of translations with language code as key and translation id as value | |
| 175 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 176 | + * @param int[] $translations An associative array of translations with language code as key and translation id as value. | |
| 177 | + * @return bool | |
| 89 | 178 | */ |
| 90 | 179 | protected function should_update_translation_group( $id, $translations ) { |
| 91 | - // Don't do anything if no translations have been added to the group | |
| 92 | - $old_translations = $this->get_translations( $id ); // Includes at least $id itself | |
| 180 | + // Don't do anything if no translations have been added to the group. | |
| 181 | + $old_translations = $this->get_translations( $id ); // Includes at least $id itself. | |
| 93 | 182 | return count( array_diff_assoc( $translations, $old_translations ) ) > 0; |
| 94 | 183 | } |
| 95 | 184 | |
| 96 | 185 | /** |
| 97 | - * Saves translations for posts or terms | |
| 186 | + * Saves translations for posts or terms. | |
| 98 | 187 | * |
| 99 | 188 | * @since 0.5 |
| 100 | 189 | * |
| 101 | - * @param int $id Post id or term id | |
| 102 | - * @param array $translations An associative array of translations with language code as key and translation id as value | |
| 190 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 191 | + * @param int[] $translations An associative array of translations with language code as key and translation id as value. | |
| 192 | + * | |
| 193 | + * @return int[] An associative array with language codes as key and post ids as values. | |
| 103 | 194 | */ |
| 104 | 195 | public function save_translations( $id, $translations ) { |
| 196 | + $translations = $this->validate_translations( $translations ); | |
| 197 | + | |
| 105 | 198 | $id = (int) $id; |
| 106 | 199 | |
| 107 | - if ( ( $lang = $this->get_language( $id ) ) && isset( $translations ) && is_array( $translations ) ) { | |
| 108 | - // sanitize the translations array | |
| 200 | + if ( $lang = $this->get_language( $id ) ) { | |
| 201 | + // Sanitize the translations array. | |
| 109 | 202 | $translations = array_map( 'intval', $translations ); |
| 110 | - $translations = array_merge( array( $lang->slug => $id ), $translations ); // make sure this object is in translations | |
| 111 | - $translations = array_diff( $translations, array( 0 ) ); // don't keep non translated languages | |
| 112 | - $translations = array_intersect_key( $translations, array_flip( $this->model->get_languages_list( array( 'fields' => 'slug' ) ) ) ); // keep only valid languages slugs as keys | |
| 203 | + $translations = array_merge( array( $lang->slug => $id ), $translations ); // Make sure this object is in translations. | |
| 204 | + $translations = array_diff( $translations, array( 0 ) ); // Don't keep non translated languages. | |
| 205 | + $translations = array_intersect_key( $translations, array_flip( $this->model->get_languages_list( array( 'fields' => 'slug' ) ) ) ); // Keep only valid languages slugs as keys. | |
| 113 | 206 | |
| 114 | - // unlink removed translations | |
| 207 | + // Unlink removed translations. | |
| 115 | 208 | $old_translations = $this->get_translations( $id ); |
| 116 | 209 | foreach ( array_diff_assoc( $old_translations, $translations ) as $object_id ) { |
| 117 | 210 | $this->delete_translation( $object_id ); |
| 118 | 211 | } |
| 119 | 212 | |
| 120 | - // Check id we need to create or update the translation group | |
| 213 | + // Check id we need to create or update the translation group. | |
| 121 | 214 | if ( $this->should_update_translation_group( $id, $translations ) ) { |
| 122 | 215 | $terms = wp_get_object_terms( $translations, $this->tax_translations ); |
| 123 | 216 | $term = reset( $terms ); |
| 124 | 217 | |
| 125 | - // create a new term if necessary | |
| 218 | + // Create a new term if necessary. | |
| 126 | 219 | if ( empty( $term ) ) { |
| 127 | 220 | wp_insert_term( $group = uniqid( 'pll_' ), $this->tax_translations, array( 'description' => maybe_serialize( $translations ) ) ); |
| 128 | - } | |
| 129 | - else { | |
| 130 | - // take care not to overwrite extra data stored in description field, if any | |
| 221 | + } else { | |
| 222 | + // Take care not to overwrite extra data stored in the description field, if any. | |
| 131 | 223 | $d = maybe_unserialize( $term->description ); |
| 132 | - $d = is_array( $d ) ? array_diff_key( $d, $old_translations ) : array(); // remove old translations | |
| 133 | - $d = array_merge( $d, $translations ); // add new one | |
| 224 | + $d = is_array( $d ) ? array_diff_key( $d, $old_translations ) : array(); // Remove old translations. | |
| 225 | + $d = array_merge( $d, $translations ); // Add new one. | |
| 134 | 226 | wp_update_term( $group = (int) $term->term_id, $this->tax_translations, array( 'description' => maybe_serialize( $d ) ) ); |
| 135 | 227 | } |
| 136 | 228 | |
| 137 | - // link all translations to the new term | |
| 229 | + // Link all translations to the new term. | |
| 138 | 230 | foreach ( $translations as $p ) { |
| 139 | 231 | wp_set_object_terms( $p, $group, $this->tax_translations ); |
| 140 | 232 | } |
| 141 | 233 | |
| 142 | - // clean now unused translation groups | |
| 234 | + // Clean now unused translation groups. | |
| 143 | 235 | foreach ( wp_list_pluck( $terms, 'term_id' ) as $term_id ) { |
| 144 | 236 | $term = get_term( $term_id, $this->tax_translations ); |
| 145 | 237 | if ( empty( $term->count ) ) { |
| 146 | 238 | wp_delete_term( $term_id, $this->tax_translations ); |
| @@ -146,17 +238,40 @@ | ||
| 146 | 238 | wp_delete_term( $term_id, $this->tax_translations ); |
| 147 | 239 | } |
| 148 | 240 | } |
| 149 | 241 | } |
| 242 | + return $translations; | |
| 243 | + } else { | |
| 244 | + return array(); | |
| 150 | 245 | } |
| 151 | 246 | } |
| 152 | 247 | |
| 153 | 248 | /** |
| 154 | - * Deletes a translation of a post or term | |
| 249 | + * Returns translations after checking the translated post is in the right language | |
| 155 | 250 | * |
| 251 | + * @since 3.1 | |
| 252 | + * | |
| 253 | + * @param int[] $translations An associative array of translations with language code as key and translation id as value. | |
| 254 | + * | |
| 255 | + * @return int[] | |
| 256 | + */ | |
| 257 | + public function validate_translations( $translations ) { | |
| 258 | + $valid_translations = array(); | |
| 259 | + | |
| 260 | + foreach ( $translations as $lang => $tr_id ) { | |
| 261 | + $valid_translations[ $lang ] = ( $tr_id && $this->get_language( (int) $tr_id )->slug == $lang ) ? (int) $tr_id : 0; | |
| 262 | + } | |
| 263 | + | |
| 264 | + return $valid_translations; | |
| 265 | + } | |
| 266 | + | |
| 267 | + /** | |
| 268 | + * Deletes a translation of a post or term. | |
| 269 | + * | |
| 156 | 270 | * @since 0.5 |
| 157 | 271 | * |
| 158 | - * @param int $id post id or term id | |
| 272 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 273 | + * @return void | |
| 159 | 274 | */ |
| 160 | 275 | public function delete_translation( $id ) { |
| 161 | 276 | $id = (int) $id; |
| 162 | 277 | $term = $this->get_object_term( $id, $this->tax_translations ); |
| @@ -176,25 +291,25 @@ | ||
| 176 | 291 | } |
| 177 | 292 | } |
| 178 | 293 | |
| 179 | 294 | /** |
| 180 | - * Returns an array of translations of a post or term | |
| 295 | + * Returns an array of translations of a post or term. | |
| 181 | 296 | * |
| 182 | 297 | * @since 0.5 |
| 183 | 298 | * |
| 184 | - * @param int $id post id or term id | |
| 185 | - * @return array an associative array of translations with language code as key and translation id as value | |
| 299 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 300 | + * @return int[] An associative array of translations with language code as key and translation id as value. | |
| 186 | 301 | */ |
| 187 | 302 | public function get_translations( $id ) { |
| 188 | 303 | $term = $this->get_object_term( $id, $this->tax_translations ); |
| 189 | 304 | $translations = empty( $term ) ? array() : maybe_unserialize( $term->description ); |
| 190 | 305 | |
| 191 | - // make sure we return only translations ( thus we allow plugins to store other information in the array ) | |
| 306 | + // Make sure we return only translations ( thus we allow plugins to store other information in the array ). | |
| 192 | 307 | if ( is_array( $translations ) ) { |
| 193 | 308 | $translations = array_intersect_key( $translations, array_flip( $this->model->get_languages_list( array( 'fields' => 'slug' ) ) ) ); |
| 194 | 309 | } |
| 195 | 310 | |
| 196 | - // make sure to return at least the passed post or term in its translation array | |
| 311 | + // Make sure to return at least the passed object in its translation array. | |
| 197 | 312 | if ( empty( $translations ) && $lang = $this->get_language( $id ) ) { |
| 198 | 313 | $translations = array( $lang->slug => $id ); |
| 199 | 314 | } |
| 200 | 315 | |
| @@ -201,15 +316,15 @@ | ||
| 201 | 316 | return $translations; |
| 202 | 317 | } |
| 203 | 318 | |
| 204 | 319 | /** |
| 205 | - * Returns the id of the translation of a post or term | |
| 320 | + * Returns the id of the translation of a post or term. | |
| 206 | 321 | * |
| 207 | 322 | * @since 0.5 |
| 208 | 323 | * |
| 209 | - * @param int $id post id or term id | |
| 210 | - * @param object|string $lang object or slug | |
| 211 | - * @return bool|int post id or term id of the translation, false if there is none | |
| 324 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 325 | + * @param PLL_Language|string $lang Language ( slug or object ). | |
| 326 | + * @return int|false Object id of the translation, false if there is none. | |
| 212 | 327 | */ |
| 213 | 328 | public function get_translation( $id, $lang ) { |
| 214 | 329 | if ( ! $lang = $this->model->get_language( $lang ) ) { |
| 215 | 330 | return false; |
| @@ -224,42 +339,56 @@ | ||
| 224 | 339 | * Among the object and its translations, returns the id of the object which is in $lang |
| 225 | 340 | * |
| 226 | 341 | * @since 0.1 |
| 227 | 342 | * |
| 228 | - * @param int $id post id or term id | |
| 229 | - * @param int|string|object $lang language ( term_id or slug or object ) | |
| 230 | - * @return bool|int the translation post id or term id if exists, otherwise the post id or term id, false if the post has no language | |
| 343 | + * @param int $id Object id ( typically a post_id or term_id ). | |
| 344 | + * @param int|string|PLL_Language $lang Language ( term_id or slug or object ). | |
| 345 | + * @return int|false The translation object id if exists, otherwise the passed id, false if the passed object has no language. | |
| 231 | 346 | */ |
| 232 | 347 | public function get( $id, $lang ) { |
| 233 | 348 | $id = (int) $id; |
| 234 | - $obj_lang = $this->get_language( $id ); // FIXME is this necessary? | |
| 235 | - if ( ! $lang || ! $obj_lang ) { | |
| 349 | + $lang = $this->model->get_language( $lang ); | |
| 350 | + $obj_lang = $this->get_language( $id ); | |
| 351 | + if ( empty( $lang ) || empty( $obj_lang ) ) { | |
| 236 | 352 | return false; |
| 237 | 353 | } |
| 238 | 354 | |
| 239 | - $lang = $this->model->get_language( $lang ); | |
| 240 | 355 | return $obj_lang->term_id == $lang->term_id ? $id : $this->get_translation( $id, $lang ); |
| 241 | 356 | } |
| 242 | 357 | |
| 243 | 358 | /** |
| 244 | - * A where clause to add to sql queries when filtering by language is needed directly in query | |
| 359 | + * A join clause to add to sql queries when filtering by language is needed directly in query. | |
| 245 | 360 | * |
| 246 | 361 | * @since 1.2 |
| 247 | 362 | * |
| 248 | - * @param object|array|string $lang a PLL_Language object or a comma separated list of language slug or an array of language slugs | |
| 249 | - * @return string where clause | |
| 363 | + * @param string $alias Optional alias for object table. | |
| 364 | + * @return string Join clause. | |
| 250 | 365 | */ |
| 366 | + abstract public function join_clause( $alias = '' ); | |
| 367 | + | |
| 368 | + /** | |
| 369 | + * A where clause to add to sql queries when filtering by language is needed directly in query. | |
| 370 | + * | |
| 371 | + * @since 1.2 | |
| 372 | + * | |
| 373 | + * @param PLL_Language|string|string[] $lang PLL_Language object or a comma separated list of language slug or an array of language slugs. | |
| 374 | + * @return string Where clause. | |
| 375 | + */ | |
| 251 | 376 | public function where_clause( $lang ) { |
| 252 | 377 | $tt_id = $this->tax_tt; |
| 253 | 378 | |
| 254 | - // $lang is an object | |
| 255 | - // generally the case if the query is coming from Polylang | |
| 379 | + /* | |
| 380 | + * $lang is an object. | |
| 381 | + * This is generally the case if the query is coming from Polylang. | |
| 382 | + */ | |
| 256 | 383 | if ( is_object( $lang ) ) { |
| 257 | 384 | return ' AND pll_tr.term_taxonomy_id = ' . absint( $lang->$tt_id ); |
| 258 | 385 | } |
| 259 | 386 | |
| 260 | - // $lang is a comma separated list of slugs ( or an array of slugs ) | |
| 261 | - // generally the case is the query is coming from outside with 'lang' parameter | |
| 387 | + /* | |
| 388 | + * $lang is a comma separated list of slugs ( or an array of slugs ). | |
| 389 | + * This is generally the case is the query is coming from outside with a 'lang' parameter. | |
| 390 | + */ | |
| 262 | 391 | $slugs = is_array( $lang ) ? $lang : explode( ',', $lang ); |
| 263 | 392 | $languages = array(); |
| 264 | 393 | foreach ( $slugs as $slug ) { |
| 265 | 394 | $languages[] = absint( $this->model->get_language( $slug )->$tt_id ); |
| @@ -268,15 +397,15 @@ | ||
| 268 | 397 | return ' AND pll_tr.term_taxonomy_id IN ( ' . implode( ',', $languages ) . ' )'; |
| 269 | 398 | } |
| 270 | 399 | |
| 271 | 400 | /** |
| 272 | - * Returns ids of objects in a language similarly to get_objects_in_term for a taxonomy | |
| 273 | - * faster than get_objects_in_term as it avoids a JOIN | |
| 401 | + * Returns ids of objects in a language similarly to get_objects_in_term() for a taxonomy. | |
| 402 | + * It is faster than get_objects_in_term() as it avoids a JOIN. | |
| 274 | 403 | * |
| 275 | 404 | * @since 1.4 |
| 276 | 405 | * |
| 277 | - * @param object $lang a PLL_Language object | |
| 278 | - * @return array | |
| 406 | + * @param PLL_Language $lang PLL_Language object. | |
| 407 | + * @return int[] Object ids. | |
| 279 | 408 | */ |
| 280 | 409 | public function get_objects_in_language( $lang ) { |
| 281 | 410 | global $wpdb; |
| 282 | 411 | $tt_id = $this->tax_tt; |
| @@ -299,26 +428,26 @@ | ||
| 299 | 428 | return $object_ids; |
| 300 | 429 | } |
| 301 | 430 | |
| 302 | 431 | /** |
| 303 | - * Check if a user can synchronize translations | |
| 432 | + * Check if a user can synchronize translations. | |
| 304 | 433 | * |
| 305 | 434 | * @since 2.6 |
| 306 | 435 | * |
| 307 | - * @param int $id Object id | |
| 436 | + * @param int $id Object id. | |
| 308 | 437 | * @return bool |
| 309 | 438 | */ |
| 310 | 439 | public function current_user_can_synchronize( $id ) { |
| 311 | 440 | /** |
| 312 | - * Filters whether a synchronization capability check should take place | |
| 441 | + * Filters whether a synchronization capability check should take place. | |
| 313 | 442 | * |
| 314 | 443 | * @since 2.6 |
| 315 | 444 | * |
| 316 | - * @param $check null to enable the capability check, | |
| 317 | - * true to always allow the synchronization, | |
| 318 | - * false to always disallow the synchronization. | |
| 319 | - * Defaults to true. | |
| 320 | - * @param $id The synchronization source object id | |
| 445 | + * @param bool|null $check Null to enable the capability check, | |
| 446 | + * true to always allow the synchronization, | |
| 447 | + * false to always disallow the synchronization. | |
| 448 | + * Defaults to true. | |
| 449 | + * @param int $id The synchronization source object id. | |
| 321 | 450 | */ |
| 322 | 451 | $check = apply_filters( "pll_pre_current_user_can_synchronize_{$this->type}", true, $id ); |
| 323 | 452 | if ( null !== $check ) { |
| 324 | 453 | return $check; |
