| @@ -1,673 +1,753 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * @package Polylang | |
| 4 | - */ | |
| 5 | 2 | |
| 6 | -/** | |
| 7 | - * Setups the language and translations model based on WordPress taxonomies | |
| 3 | +/* | |
| 4 | + * setups the language and translations model based on WordPress taxonomies | |
| 8 | 5 | * |
| 9 | 6 | * @since 1.2 |
| 10 | 7 | */ |
| 11 | 8 | class PLL_Model { |
| 12 | - public $cache; // Our internal non persistent cache object | |
| 13 | 9 | public $options; |
| 14 | - public $post, $term; // Translated objects models | |
| 10 | + private $languages; // used to cache the list of languages | |
| 15 | 11 | |
| 16 | - /** | |
| 17 | - * Constructor | |
| 18 | - * setups translated objects sub models | |
| 19 | - * setups filters and actions | |
| 12 | + /* | |
| 13 | + * constructor: registers custom taxonomies and setups filters and actions | |
| 20 | 14 | * |
| 21 | 15 | * @since 1.2 |
| 22 | 16 | * |
| 23 | 17 | * @param array $options Polylang options |
| 24 | 18 | */ |
| 25 | - public function __construct( &$options ) { | |
| 19 | + public function __construct(&$options) { | |
| 26 | 20 | $this->options = &$options; |
| 27 | 21 | |
| 28 | - $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 | |
| 22 | + // register our taxonomies as soon as possible | |
| 23 | + // this is early registration, not ready for rewrite rules as wp_rewrite will be setup later | |
| 24 | + $args = array('label' => false, 'public' => false, 'query_var' => false, 'rewrite' => false, '_pll' => true); | |
| 25 | + register_taxonomy('language', null, $args); | |
| 26 | + register_taxonomy('term_language', 'term', $args); | |
| 27 | + register_taxonomy('term_translations', 'term', $args); | |
| 28 | + $args['update_count_callback'] = '_update_generic_term_count'; // count *all* posts to avoid deleting in clean_translations_terms | |
| 29 | + register_taxonomy('post_translations', null, $args); | |
| 31 | 30 | |
| 32 | - // We need to clean languages cache when editing a language and when modifying the permalink structure | |
| 33 | - add_action( 'edited_term_taxonomy', array( $this, 'clean_languages_cache' ), 10, 2 ); | |
| 34 | - add_action( 'update_option_permalink_structure', array( $this, 'clean_languages_cache' ) ); | |
| 35 | - add_action( 'update_option_siteurl', array( $this, 'clean_languages_cache' ) ); | |
| 36 | - add_action( 'update_option_home', array( $this, 'clean_languages_cache' ) ); | |
| 31 | + add_filter('get_terms', array(&$this, '_prime_terms_cache'), 10, 2); | |
| 32 | + add_filter('wp_get_object_terms', array(&$this, 'wp_get_object_terms'), 10, 3); | |
| 37 | 33 | |
| 38 | - add_filter( 'get_terms_args', array( $this, 'get_terms_args' ) ); | |
| 34 | + // we need to clean languages cache when editing a language, | |
| 35 | + // when editing page of front or when modifying the permalink structure | |
| 36 | + add_action('edited_term_taxonomy', array(&$this, 'clean_languages_cache'), 10, 2); | |
| 37 | + add_action('update_option_page_on_front', array(&$this, 'clean_languages_cache')); | |
| 38 | + add_action('update_option_permalink_structure', array(&$this, 'clean_languages_cache')); | |
| 39 | 39 | |
| 40 | - // Just in case someone would like to display the language description ;- ) | |
| 41 | - add_filter( 'language_description', '__return_empty_string' ); | |
| 40 | + // registers completely the language taxonomy | |
| 41 | + add_action('setup_theme', array(&$this, 'register_taxonomy'), 1); | |
| 42 | + | |
| 43 | + // setups post types to translate | |
| 44 | + add_action('registered_post_type', array(&$this, 'registered_post_type')); | |
| 45 | + | |
| 46 | + // just in case someone would like to display the language description ;-) | |
| 47 | + add_filter('language_description', create_function('$v', "return '';")); | |
| 42 | 48 | } |
| 43 | 49 | |
| 44 | - /** | |
| 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 | |
| 50 | + /* | |
| 51 | + * cache language and translations when terms are queried by get_terms | |
| 48 | 52 | * |
| 49 | - * List of parameters accepted in $args: | |
| 53 | + * @since 1.2 | |
| 50 | 54 | * |
| 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 ) | |
| 55 | + * @param array $terms queried terms | |
| 56 | + * @param array $taxonomies queried taxonomies | |
| 57 | + * @return array unmodified $terms | |
| 58 | + */ | |
| 59 | + public function _prime_terms_cache($terms, $taxonomies) { | |
| 60 | + if ($this->is_translated_taxonomy($taxonomies)) { | |
| 61 | + foreach ($terms as $term) { | |
| 62 | + $term_ids[] = is_object($term) ? $term->term_id : $term; | |
| 63 | + } | |
| 64 | + } | |
| 65 | + | |
| 66 | + if (!empty($term_ids)) | |
| 67 | + update_object_term_cache(array_unique($term_ids), 'term'); // adds language and translation of terms to cache | |
| 68 | + return $terms; | |
| 69 | + } | |
| 70 | + | |
| 71 | + /* | |
| 72 | + * when terms are found for posts, add their language and translations to cache | |
| 53 | 73 | * |
| 74 | + * @since 1.2 | |
| 75 | + * | |
| 76 | + * @param array $terms terms found | |
| 77 | + * @param array $object_ids not used | |
| 78 | + * @param array $taxonomies terms taxonomies | |
| 79 | + * @return array unmodified $terms | |
| 80 | + */ | |
| 81 | + // FIXME is that useful? or even desirable? | |
| 82 | + public function wp_get_object_terms($terms, $object_ids, $taxonomies) { | |
| 83 | + $taxonomies = explode("', '", trim($taxonomies, "'")); | |
| 84 | + if (!in_array('term_translations', $taxonomies)) | |
| 85 | + $this->_prime_terms_cache($terms, $taxonomies); | |
| 86 | + return $terms; | |
| 87 | + } | |
| 88 | + | |
| 89 | + /* | |
| 90 | + * wrap wp_get_object_terms to cache it and return only one object | |
| 91 | + * inspired by the function get_the_terms | |
| 92 | + * | |
| 93 | + * @since 1.2 | |
| 94 | + * | |
| 95 | + * @param int $object_id post_id or term_id | |
| 96 | + * @param string $taxonomy Polylang taxonomy depending if we are looking for a post (or term) language (or translation) | |
| 97 | + * @return bool|object the term associated to the object in the requested taxonomy if exists, false otherwise | |
| 98 | + */ | |
| 99 | + protected function get_object_term($object_id, $taxonomy) { | |
| 100 | + $term = get_object_term_cache($object_id, $taxonomy); | |
| 101 | + | |
| 102 | + if ( false === $term ) { | |
| 103 | + // query language and translations at the same time | |
| 104 | + $taxonomies = (false !== strpos($taxonomy, 'term_')) ? | |
| 105 | + array('term_language', 'term_translations') : | |
| 106 | + array('language', 'post_translations'); | |
| 107 | + | |
| 108 | + foreach (wp_get_object_terms($object_id, $taxonomies) as $t) { | |
| 109 | + wp_cache_add($object_id, array($t), $t->taxonomy . '_relationships'); // store it the way WP wants it | |
| 110 | + if ($t->taxonomy == $taxonomy) | |
| 111 | + $term = $t; | |
| 112 | + } | |
| 113 | + } | |
| 114 | + else { | |
| 115 | + $term = reset($term); | |
| 116 | + } | |
| 117 | + | |
| 118 | + return empty($term) ? false : $term; | |
| 119 | + } | |
| 120 | + | |
| 121 | + /* | |
| 122 | + * returns the list of available languages | |
| 123 | + * caches the list in a db transient (except flags) | |
| 124 | + * caches the list (with flags) in the private property $languages | |
| 125 | + * | |
| 126 | + * list of parameters accepted in $args: | |
| 127 | + * | |
| 128 | + * hide_empty => hides languages with no posts if set to true (defaults to false) | |
| 129 | + * fields => return only that field if set (see PLL_Language for a list of fields) | |
| 130 | + * | |
| 54 | 131 | * @since 0.1 |
| 55 | 132 | * |
| 56 | 133 | * @param array $args |
| 57 | 134 | * @return array|string|int list of PLL_Language objects or PLL_Language object properties |
| 58 | 135 | */ |
| 59 | - public function get_languages_list( $args = array() ) { | |
| 60 | - if ( false === $languages = $this->cache->get( 'languages' ) ) { | |
| 136 | + public function get_languages_list($args = array()) { | |
| 137 | + if (empty($this->languages)) { | |
| 138 | + if (false === ($languages = get_transient('pll_languages_list'))) { | |
| 139 | + $languages = get_terms('language', array('hide_empty' => false, 'orderby'=> 'term_group')); | |
| 140 | + $languages = empty($languages) || is_wp_error($languages) ? array() : $languages; | |
| 61 | 141 | |
| 62 | - // Create the languages from taxonomies | |
| 63 | - if ( ( defined( 'PLL_CACHE_LANGUAGES' ) && ! PLL_CACHE_LANGUAGES ) || false === ( $languages = get_transient( 'pll_languages_list' ) ) ) { | |
| 64 | - $languages = get_terms( 'language', array( 'hide_empty' => false, 'orderby' => 'term_group' ) ); | |
| 65 | - $languages = empty( $languages ) || is_wp_error( $languages ) ? array() : $languages; | |
| 142 | + $term_languages = get_terms('term_language', array('hide_empty' => false)); | |
| 143 | + $term_languages = empty($term_languages) || is_wp_error($term_languages) ? | |
| 144 | + array() : array_combine(wp_list_pluck($term_languages, 'name'), $term_languages); | |
| 66 | 145 | |
| 67 | - $term_languages = get_terms( 'term_language', array( 'hide_empty' => false ) ); | |
| 68 | - $term_languages = empty( $term_languages ) || is_wp_error( $term_languages ) ? | |
| 69 | - array() : array_combine( wp_list_pluck( $term_languages, 'slug' ), $term_languages ); | |
| 70 | - | |
| 71 | - 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 | |
| 73 | - foreach ( $languages as $k => $v ) { | |
| 74 | - $languages[ $k ] = new PLL_Language( $v, $term_languages[ 'pll_' . $v->slug ] ); | |
| 146 | + if (!empty($languages) && !empty($term_languages)) { | |
| 147 | + // don't use array_map + create_function to instantiate an autoloaded class as it breaks badly in old versions of PHP | |
| 148 | + foreach ($languages as $k => $v) { | |
| 149 | + $languages[$k] = new PLL_Language($v, $term_languages[$v->name]); | |
| 75 | 150 | } |
| 76 | - | |
| 77 | - // We will need the languages list to allow its access in the filter below | |
| 78 | - $this->cache->set( 'languages', $languages ); | |
| 79 | - | |
| 80 | - /** | |
| 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 | |
| 83 | - * | |
| 84 | - * @since 1.7.5 | |
| 85 | - * | |
| 86 | - * @param array $languages the list of language objects | |
| 87 | - * @param object $model PLL_Model object | |
| 88 | - */ | |
| 89 | - $languages = apply_filters( 'pll_languages_list', $languages, $this ); | |
| 90 | - | |
| 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; | |
| 94 | - set_transient( 'pll_languages_list', array_map( 'get_object_vars', $languages ) ); | |
| 95 | 151 | } |
| 96 | 152 | else { |
| 97 | - $languages = array(); // In case something went wrong | |
| 153 | + $languages = array(); // in case something went wrong | |
| 98 | 154 | } |
| 99 | 155 | } |
| 100 | 156 | |
| 101 | - // Create the languages directly from arrays stored in transients | |
| 102 | - else { | |
| 103 | - foreach ( $languages as $k => $v ) { | |
| 104 | - $languages[ $k ] = new PLL_Language( $v ); | |
| 105 | - } | |
| 106 | - } | |
| 157 | + $this->languages = $languages; | |
| 107 | 158 | |
| 108 | - /** | |
| 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 | |
| 111 | - * | |
| 112 | - * @since 1.8 | |
| 113 | - * | |
| 114 | - * @param array $languages the list of language objects | |
| 115 | - */ | |
| 116 | - $languages = apply_filters( 'pll_after_languages_cache', $languages ); | |
| 117 | - $this->cache->set( 'languages', $languages ); | |
| 159 | + // need to wait for $wp_rewrite availibility to set homepage urls | |
| 160 | + did_action('setup_theme') ? $this->_languages_list() : add_action('setup_theme', array(&$this, '_languages_list')); | |
| 118 | 161 | } |
| 119 | 162 | |
| 120 | - $args = wp_parse_args( $args, array( 'hide_empty' => false ) ); | |
| 163 | + $args = wp_parse_args($args, array('hide_empty' => false)); | |
| 121 | 164 | |
| 122 | - // Remove empty languages if requested | |
| 123 | - if ( $args['hide_empty'] ) { | |
| 124 | - $languages = wp_list_filter( $languages, array( 'count' => 0 ), 'NOT' ); | |
| 165 | + // remove empty languages if requested | |
| 166 | + $languages = array_filter($this->languages, create_function('$v', sprintf('return $v->count || !%d;', $args['hide_empty']))); | |
| 167 | + | |
| 168 | + return empty($args['fields']) ? $languages : wp_list_pluck($languages, $args['fields']); | |
| 169 | + } | |
| 170 | + | |
| 171 | + /* | |
| 172 | + * fills home urls and flags in language list and set transient in db | |
| 173 | + * delayed to be sure we have access to $wp_rewrite for home urls | |
| 174 | + * home urls are not cached in db if PLL_CACHE_HOME_URL is set to false | |
| 175 | + * | |
| 176 | + * @since 1.4 | |
| 177 | + */ | |
| 178 | + public function _languages_list() { | |
| 179 | + if (false === get_transient('pll_languages_list')) { | |
| 180 | + if (!defined('PLL_CACHE_HOME_URL') || PLL_CACHE_HOME_URL) { | |
| 181 | + foreach ($this->languages as $language) | |
| 182 | + $language->set_home_url(); | |
| 183 | + } | |
| 184 | + set_transient('pll_languages_list', $this->languages); | |
| 125 | 185 | } |
| 126 | 186 | |
| 127 | - return empty( $args['fields'] ) ? $languages : wp_list_pluck( $languages, $args['fields'] ); | |
| 187 | + foreach ($this->languages as $language) { | |
| 188 | + if (defined('PLL_CACHE_HOME_URL') && !PLL_CACHE_HOME_URL) | |
| 189 | + $language->set_home_url(); | |
| 190 | + | |
| 191 | + // add flags (not in db cache as they may be different on frontend and admin) | |
| 192 | + $language->set_flag(); | |
| 193 | + } | |
| 128 | 194 | } |
| 129 | 195 | |
| 130 | - /** | |
| 131 | - * Cleans language cache | |
| 196 | + /* | |
| 197 | + * cleans language cache | |
| 132 | 198 | * can be called directly with no parameter |
| 133 | 199 | * called by the 'edited_term_taxonomy' filter with 2 parameters when count needs to be updated |
| 134 | 200 | * |
| 135 | 201 | * @since 1.2 |
| 136 | 202 | * |
| 137 | - * @param int $term not used | |
| 203 | + * @param int $term not used | |
| 138 | 204 | * @param string $taxonomy taxonomy name |
| 139 | 205 | */ |
| 140 | - public function clean_languages_cache( $term = 0, $taxonomy = null ) { | |
| 141 | - if ( empty( $taxonomy ) || 'language' == $taxonomy ) { | |
| 142 | - delete_transient( 'pll_languages_list' ); | |
| 143 | - $this->cache->clean(); | |
| 206 | + public function clean_languages_cache($term = 0, $taxonomy = null) { | |
| 207 | + if (empty($taxonomy->name) || 'language' == $taxonomy->name) { | |
| 208 | + delete_transient('pll_languages_list'); | |
| 209 | + $this->languages = array(); | |
| 144 | 210 | } |
| 145 | 211 | } |
| 146 | 212 | |
| 147 | - /** | |
| 148 | - * Don't query term metas when only our taxonomies are queried | |
| 213 | + /* | |
| 214 | + * returns the language by its term_id, tl_term_id, slug or locale | |
| 149 | 215 | * |
| 150 | - * @since 2.3 | |
| 216 | + * @since 0.1 | |
| 151 | 217 | * |
| 152 | - * @param array $args WP_Term_Query arguments | |
| 153 | - * @return array | |
| 218 | + * @param int|string term_id, tl_term_id, slug or locale of the queried language | |
| 219 | + * @return object|bool PLL_Language object, false if no language found | |
| 154 | 220 | */ |
| 155 | - public function get_terms_args( $args ) { | |
| 156 | - if ( isset( $args['taxonomy'] ) && ! array_diff( (array) $args['taxonomy'], array( 'language', 'term_language', 'post_translations', 'term_translations' ) ) ) { | |
| 157 | - $args['update_term_meta_cache'] = false; | |
| 221 | + public function get_language($value) { | |
| 222 | + static $language; | |
| 223 | + | |
| 224 | + if (is_object($value)) | |
| 225 | + return $this->get_language($value->term_id); // will force cast to PLL_Language | |
| 226 | + | |
| 227 | + if (empty($language[$value])) { | |
| 228 | + foreach ($this->get_languages_list() as $lang) | |
| 229 | + $language[$lang->term_id] = $language[$lang->tl_term_id] = $language[$lang->slug] = $language[$lang->locale] = $lang; | |
| 158 | 230 | } |
| 159 | - return $args; | |
| 231 | + | |
| 232 | + return empty($language[$value]) ? false : $language[$value]; | |
| 160 | 233 | } |
| 161 | 234 | |
| 162 | - /** | |
| 163 | - * Returns the language by its term_id, tl_term_id, slug or locale | |
| 235 | + /* | |
| 236 | + * removes unused translations terms in database | |
| 164 | 237 | * |
| 165 | - * @since 0.1 | |
| 238 | + * @since 1.5 | |
| 166 | 239 | * |
| 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 | |
| 240 | + * @param string $type either 'post' or 'term' | |
| 169 | 241 | */ |
| 170 | - public function get_language( $value ) { | |
| 171 | - if ( is_object( $value ) ) { | |
| 172 | - return $value instanceof PLL_Language ? $value : $this->get_language( $value->term_id ); // will force cast to PLL_Language | |
| 173 | - } | |
| 242 | + protected function clean_translations_terms($type) { | |
| 243 | + global $wpdb; | |
| 244 | + $ids = $wpdb->get_col("SELECT term_id FROM $wpdb->term_taxonomy WHERE taxonomy IN ('{$type}_translations') AND count = 0"); | |
| 245 | + foreach ($ids as $id) | |
| 246 | + wp_delete_term((int) $id, $type . '_translations'); | |
| 247 | + } | |
| 174 | 248 | |
| 175 | - if ( false === $return = $this->cache->get( 'language:' . $value ) ) { | |
| 176 | - foreach ( $this->get_languages_list() as $lang ) { | |
| 177 | - $this->cache->set( 'language:' . $lang->term_id, $lang ); | |
| 178 | - $this->cache->set( 'language:' . $lang->tl_term_id, $lang ); | |
| 179 | - $this->cache->set( 'language:' . $lang->slug, $lang ); | |
| 180 | - $this->cache->set( 'language:' . $lang->locale, $lang ); | |
| 181 | - $this->cache->set( 'language:' . $lang->w3c, $lang ); | |
| 249 | + /* | |
| 250 | + * saves translations for posts or terms | |
| 251 | + * | |
| 252 | + * @since 0.5 | |
| 253 | + * | |
| 254 | + * @param string $type either 'post' or 'term' | |
| 255 | + * @param int $id post id or term id | |
| 256 | + * @param array $translations: an associative array of translations with language code as key and translation id as value | |
| 257 | + */ | |
| 258 | + public function save_translations($type, $id, $translations) { | |
| 259 | + if (($lang = call_user_func(array(&$this, 'get_'.$type.'_language'), $id)) && isset($translations) && is_array($translations)) { | |
| 260 | + | |
| 261 | + $translations = array_merge(array($lang->slug => $id), $translations); // make sure this object is in translations | |
| 262 | + $translations = array_diff($translations, array(0)); // don't keep non translated languages | |
| 263 | + | |
| 264 | + // unlink removed translations | |
| 265 | + $old_translations = $this->get_translations($type, $id); | |
| 266 | + foreach (array_diff_assoc($old_translations, $translations) as $object_id) | |
| 267 | + $this->delete_translation($type, $object_id); | |
| 268 | + | |
| 269 | + // don't create a translation group for untranslated posts as it is useless | |
| 270 | + // but we need one for terms to allow relationships remap when importing from a WXR file | |
| 271 | + if ('term' == $type || count($translations) > 1) { | |
| 272 | + $terms = wp_get_object_terms($translations, $type . '_translations'); | |
| 273 | + $term = reset($terms); | |
| 274 | + | |
| 275 | + // create a new term if necessary | |
| 276 | + if (empty($term)) { | |
| 277 | + wp_insert_term($group = uniqid('pll_'), $type . '_translations', array('description' => serialize($translations))); | |
| 278 | + } | |
| 279 | + else { | |
| 280 | + // take care not to overwrite extra data stored in description field, if any | |
| 281 | + $d = unserialize($term->description); | |
| 282 | + $d = is_array($d) ? array_diff_key($d, $old_translations) : array(); // remove old translations | |
| 283 | + $d = array_merge($d, $translations); // add new one | |
| 284 | + wp_update_term($group = (int) $term->term_id, $type . '_translations', array('description' => serialize($d))); | |
| 285 | + } | |
| 286 | + | |
| 287 | + // link all translations to the new term | |
| 288 | + foreach($translations as $p) | |
| 289 | + wp_set_object_terms($p, $group, $type . '_translations'); | |
| 290 | + | |
| 291 | + // clean unused terms to avoid orphans in db | |
| 292 | + $this->clean_translations_terms($type); | |
| 182 | 293 | } |
| 183 | - $return = $this->cache->get( 'language:' . $value ); | |
| 184 | 294 | } |
| 185 | - | |
| 186 | - return $return; | |
| 187 | 295 | } |
| 188 | 296 | |
| 189 | - /** | |
| 190 | - * Adds terms clauses to get_terms to filter them by languages - used in both frontend and admin | |
| 297 | + /* | |
| 298 | + * deletes a translation of a post or term | |
| 191 | 299 | * |
| 192 | - * @since 1.2 | |
| 300 | + * @since 0.5 | |
| 193 | 301 | * |
| 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 | |
| 302 | + * @param string $type either 'post' or 'term' | |
| 303 | + * @param int $id post id or term id | |
| 197 | 304 | */ |
| 198 | - public function terms_clauses( $clauses, $lang ) { | |
| 199 | - if ( ! empty( $lang ) && false === strpos( $clauses['join'], 'pll_tr' ) ) { | |
| 200 | - $clauses['join'] .= $this->term->join_clause(); | |
| 201 | - $clauses['where'] .= $this->term->where_clause( $lang ); | |
| 305 | + public function delete_translation($type, $id) { | |
| 306 | + $term = $this->get_object_term($id, $type . '_translations'); | |
| 307 | + | |
| 308 | + if (!empty($term)) { | |
| 309 | + $d = unserialize($term->description); | |
| 310 | + $slug = array_search($id, $this->get_translations($type, $id)); // in case some plugin stores the same value with different key | |
| 311 | + unset($d[$slug]); | |
| 312 | + | |
| 313 | + wp_update_term((int) $term->term_id, $type . '_translations', array('description' => serialize($d))); | |
| 314 | + | |
| 315 | + if ('post' == $type) | |
| 316 | + wp_set_object_terms($id, null, $type . '_translations'); | |
| 317 | + else { | |
| 318 | + // always keep a group for terms to allow relationships remap when importing from a WXR file | |
| 319 | + $translations[$slug] = $id; | |
| 320 | + wp_insert_term($group = uniqid('pll_'), $type . '_translations', array('description' => serialize($translations))); | |
| 321 | + wp_set_object_terms($id, $group, $type . '_translations'); | |
| 322 | + } | |
| 323 | + | |
| 324 | + // clean unused terms to avoid orphans in db | |
| 325 | + $this->clean_translations_terms($type); | |
| 202 | 326 | } |
| 203 | - return $clauses; | |
| 204 | 327 | } |
| 205 | 328 | |
| 206 | - /** | |
| 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 | |
| 329 | + /* | |
| 330 | + * returns the id of the translation of a post or term | |
| 210 | 331 | * |
| 211 | - * @since 1.2 | |
| 332 | + * @since 0.5 | |
| 212 | 333 | * |
| 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 | |
| 334 | + * @param string $type either 'post' or 'term' | |
| 335 | + * @param int $id post id or term id | |
| 336 | + * @param object|string $lang object or slug | |
| 337 | + * @return bool|int post id or term id of the translation, flase if there is none | |
| 215 | 338 | */ |
| 216 | - public function get_translated_post_types( $filter = true ) { | |
| 217 | - if ( false === $post_types = $this->cache->get( 'post_types' ) ) { | |
| 218 | - $post_types = array( 'post' => 'post', 'page' => 'page', 'wp_block' => 'wp_block' ); | |
| 339 | + public function get_translation($type, $id, $lang) { | |
| 340 | + if (!$lang = $this->get_language($lang)) | |
| 341 | + return false; | |
| 219 | 342 | |
| 220 | - if ( ! empty( $this->options['media_support'] ) ) { | |
| 221 | - $post_types['attachment'] = 'attachment'; | |
| 222 | - } | |
| 343 | + $translations = $this->get_translations($type, $id); | |
| 223 | 344 | |
| 224 | - if ( ! empty( $this->options['post_types'] ) && is_array( $this->options['post_types'] ) ) { | |
| 225 | - $post_types = array_merge( $post_types, array_combine( $this->options['post_types'], $this->options['post_types'] ) ); | |
| 226 | - } | |
| 345 | + return isset($translations[$lang->slug]) ? (int) $translations[$lang->slug] : false; | |
| 346 | + } | |
| 227 | 347 | |
| 228 | - /** | |
| 229 | - * Filter the list of post types available for translation. | |
| 230 | - * The default are post types which have the parameter ‘public’ set to true. | |
| 231 | - * The filter must be added soon in the WordPress loading process: | |
| 232 | - * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. | |
| 233 | - * | |
| 234 | - * @since 0.8 | |
| 235 | - * | |
| 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 | |
| 238 | - */ | |
| 239 | - $post_types = apply_filters( 'pll_get_post_types', $post_types, false ); | |
| 348 | + /* | |
| 349 | + * returns an array of translations of a post or term | |
| 350 | + * | |
| 351 | + * @since 0.5 | |
| 352 | + * | |
| 353 | + * @param string $type either 'post' or 'term' | |
| 354 | + * @param int $id post id or term id | |
| 355 | + * @return array an associative array of translations with language code as key and translation id as value | |
| 356 | + */ | |
| 357 | + public function get_translations($type, $id) { | |
| 358 | + $type = ($type == 'post' || $this->is_translated_post_type($type)) ? 'post' : (($type == 'term' || $this->is_translated_taxonomy($type)) ? 'term' : false); | |
| 359 | + $translations = $type && ($term = $this->get_object_term($id, $type . '_translations')) && !empty($term) ? unserialize($term->description) : array(); | |
| 240 | 360 | |
| 241 | - if ( did_action( 'after_setup_theme' ) ) { | |
| 242 | - $this->cache->set( 'post_types', $post_types ); | |
| 243 | - } | |
| 244 | - } | |
| 361 | + // make sure we return only translations (thus we allow plugins to store other informations in the array) | |
| 362 | + return array_intersect_key($translations, array_flip($this->get_languages_list(array('fields' => 'slug')))); | |
| 363 | + } | |
| 245 | 364 | |
| 246 | - return $filter ? array_intersect( $post_types, get_post_types() ) : $post_types; | |
| 365 | + /* | |
| 366 | + * store the post language in the database | |
| 367 | + * | |
| 368 | + * @since 0.6 | |
| 369 | + * | |
| 370 | + * @param int $post_id post id | |
| 371 | + * @param int|string|object language (term_id or slug or object) | |
| 372 | + */ | |
| 373 | + public function set_post_language($post_id, $lang) { | |
| 374 | + wp_set_post_terms($post_id, $lang ? $this->get_language($lang)->slug : '', 'language' ); | |
| 247 | 375 | } |
| 248 | 376 | |
| 249 | - /** | |
| 250 | - * Returns true if Polylang manages languages and translations for this post type | |
| 377 | + /* | |
| 378 | + * returns the language of a post | |
| 251 | 379 | * |
| 252 | - * @since 1.2 | |
| 380 | + * @since 0.1 | |
| 253 | 381 | * |
| 254 | - * @param string|array $post_type post type name or array of post type names | |
| 255 | - * @return bool | |
| 382 | + * @param int $post_id post id | |
| 383 | + * @return bool|object PLL_Language object, false if no language is associated to that post | |
| 256 | 384 | */ |
| 257 | - public function is_translated_post_type( $post_type ) { | |
| 258 | - $post_types = $this->get_translated_post_types( false ); | |
| 259 | - return ( is_array( $post_type ) && array_intersect( $post_type, $post_types ) || in_array( $post_type, $post_types ) || 'any' === $post_type && ! empty( $post_types ) ); | |
| 385 | + public function get_post_language($post_id) { | |
| 386 | + $lang = $this->get_object_term($post_id, 'language' ); | |
| 387 | + return ($lang) ? $this->get_language($lang) : false; | |
| 260 | 388 | } |
| 261 | 389 | |
| 262 | - /** | |
| 263 | - * Return taxonomies that need to be translated | |
| 390 | + /* | |
| 391 | + * among the post and its translations, returns the id of the post which is in $lang | |
| 264 | 392 | * |
| 265 | - * @since 1.2 | |
| 393 | + * @since 0.1 | |
| 266 | 394 | * |
| 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 | |
| 395 | + * @param int $post_id post id | |
| 396 | + * @param int|string|object language (term_id or slug or object) | |
| 397 | + * @return bool|int the translation post id if exists, otherwise the post id, false if the post has no language | |
| 269 | 398 | */ |
| 270 | - public function get_translated_taxonomies( $filter = true ) { | |
| 271 | - if ( false === $taxonomies = $this->cache->get( 'taxonomies' ) ) { | |
| 272 | - $taxonomies = array( 'category' => 'category', 'post_tag' => 'post_tag' ); | |
| 399 | + public function get_post($post_id, $lang) { | |
| 400 | + $post_lang = $this->get_post_language($post_id); // FIXME is this necessary? | |
| 401 | + if (!$lang || !$post_lang) | |
| 402 | + return false; | |
| 273 | 403 | |
| 274 | - if ( ! empty( $this->options['taxonomies'] ) && is_array( $this->options['taxonomies'] ) ) { | |
| 275 | - $taxonomies = array_merge( $taxonomies, array_combine( $this->options['taxonomies'], $this->options['taxonomies'] ) ); | |
| 276 | - } | |
| 404 | + $lang = $this->get_language($lang); | |
| 405 | + return $post_lang->term_id == $lang->term_id ? $post_id : $this->get_translation('post', $post_id, $lang); | |
| 406 | + } | |
| 277 | 407 | |
| 278 | - /** | |
| 279 | - * Filter the list of taxonomies available for translation. | |
| 280 | - * The default are taxonomies which have the parameter ‘public’ set to true. | |
| 281 | - * The filter must be added soon in the WordPress loading process: | |
| 282 | - * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. | |
| 283 | - * | |
| 284 | - * @since 0.8 | |
| 285 | - * | |
| 286 | - * @param array $taxonomies list of taxonomy names | |
| 287 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 288 | - */ | |
| 289 | - $taxonomies = apply_filters( 'pll_get_taxonomies', $taxonomies, false ); | |
| 290 | - if ( did_action( 'after_setup_theme' ) ) { | |
| 291 | - $this->cache->set( 'taxonomies', $taxonomies ); | |
| 292 | - } | |
| 293 | - } | |
| 294 | - | |
| 295 | - return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; | |
| 408 | + /* | |
| 409 | + * stores the term language in the database | |
| 410 | + * | |
| 411 | + * @since 0.6 | |
| 412 | + * | |
| 413 | + * @param int $term_id term id | |
| 414 | + * @param int|string|object language (term_id or slug or object) | |
| 415 | + */ | |
| 416 | + public function set_term_language($term_id, $lang) { | |
| 417 | + wp_set_object_terms($term_id, $lang ? $this->get_language($lang)->tl_term_id : '', 'term_language'); | |
| 296 | 418 | } |
| 297 | 419 | |
| 298 | - /** | |
| 299 | - * Returns true if Polylang manages languages and translations for this taxonomy | |
| 420 | + /* | |
| 421 | + * removes the term language in database | |
| 300 | 422 | * |
| 301 | - * @since 1.2 | |
| 423 | + * @since 0.5 | |
| 302 | 424 | * |
| 303 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 304 | - * @return bool | |
| 425 | + * @param int $term_id term id | |
| 305 | 426 | */ |
| 306 | - public function is_translated_taxonomy( $tax ) { | |
| 307 | - $taxonomies = $this->get_translated_taxonomies( false ); | |
| 308 | - return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); | |
| 427 | + public function delete_term_language($term_id) { | |
| 428 | + wp_delete_object_term_relationships($term_id, 'term_language'); | |
| 309 | 429 | } |
| 310 | 430 | |
| 311 | - /** | |
| 312 | - * Return taxonomies that need to be filtered ( post_format like ) | |
| 431 | + /* | |
| 432 | + * returns the language of a term | |
| 313 | 433 | * |
| 314 | - * @since 1.7 | |
| 434 | + * @since 0.1 | |
| 315 | 435 | * |
| 316 | - * @param bool $filter true if we should return only valid registered taxonomies | |
| 317 | - * @return array array of registered taxonomy names | |
| 436 | + * @param int|string $value term id or term slug | |
| 437 | + * @param string $taxonomy optional taxonomy needed when the term slug is passed as first parameter | |
| 438 | + * @return bool|object PLL_Language object, false if no language is associated to that term | |
| 318 | 439 | */ |
| 319 | - public function get_filtered_taxonomies( $filter = true ) { | |
| 320 | - if ( did_action( 'after_setup_theme' ) ) { | |
| 321 | - static $taxonomies = null; | |
| 322 | - } | |
| 440 | + public function get_term_language($value, $taxonomy = '') { | |
| 441 | + if (is_numeric($value)) | |
| 442 | + $term_id = $value; | |
| 323 | 443 | |
| 324 | - if ( empty( $taxonomies ) ) { | |
| 325 | - $taxonomies = array( 'post_format' => 'post_format' ); | |
| 444 | + // get_term_by still not cached in WP 3.5.1 but internally, the function is always called by term_id | |
| 445 | + elseif (is_string($value) && $taxonomy) | |
| 446 | + $term_id = get_term_by('slug', $value , $taxonomy)->term_id; | |
| 326 | 447 | |
| 327 | - /** | |
| 328 | - * Filter the list of taxonomies not translatable but filtered by language. | |
| 329 | - * Includes only the post format by default | |
| 330 | - * The filter must be added soon in the WordPress loading process: | |
| 331 | - * in a function hooked to ‘plugins_loaded’ or directly in functions.php for themes. | |
| 332 | - * | |
| 333 | - * @since 1.7 | |
| 334 | - * | |
| 335 | - * @param array $taxonomies list of taxonomy names | |
| 336 | - * @param bool $is_settings true when displaying the list of custom taxonomies in Polylang settings | |
| 337 | - */ | |
| 338 | - $taxonomies = apply_filters( 'pll_filtered_taxonomies', $taxonomies, false ); | |
| 339 | - } | |
| 448 | + $lang = $this->get_object_term($term_id, 'term_language'); | |
| 340 | 449 | |
| 341 | - return $filter ? array_intersect( $taxonomies, get_taxonomies() ) : $taxonomies; | |
| 450 | + // switch to PLL_Language | |
| 451 | + return ($lang) ? $this->get_language($lang->term_id) : false; | |
| 342 | 452 | } |
| 343 | 453 | |
| 344 | - /** | |
| 345 | - * Returns true if Polylang filters this taxonomy per language | |
| 454 | + /* | |
| 455 | + * among the term and its translations, returns the id of the term which is in $lang | |
| 346 | 456 | * |
| 347 | - * @since 1.7 | |
| 457 | + * @since 0.1 | |
| 348 | 458 | * |
| 349 | - * @param string|array $tax taxonomy name or array of taxonomy names | |
| 350 | - * @return bool | |
| 459 | + * @param int $term_id term id | |
| 460 | + * @param int|string|object language (term_id or slug or object) | |
| 461 | + * @return bool|int the translation term id if exists, otherwise the term id, false if the term has no language | |
| 351 | 462 | */ |
| 352 | - public function is_filtered_taxonomy( $tax ) { | |
| 353 | - $taxonomies = $this->get_filtered_taxonomies( false ); | |
| 354 | - return ( is_array( $tax ) && array_intersect( $tax, $taxonomies ) || in_array( $tax, $taxonomies ) ); | |
| 463 | + public function get_term($term_id, $lang) { | |
| 464 | + $lg = $this->get_term_language($term_id); // FIXME is this necessary? | |
| 465 | + if (!$lang || !$lg) | |
| 466 | + return false; | |
| 467 | + | |
| 468 | + $lang = $this->get_language($lang); | |
| 469 | + return $lg->term_id == $lang->term_id ? $term_id : $this->get_translation('term', $term_id, $lang); | |
| 355 | 470 | } |
| 356 | 471 | |
| 357 | - /** | |
| 358 | - * Returns the query vars of all filtered taxonomies | |
| 472 | + /* | |
| 473 | + * a join clause to add to sql queries when filtering by language is needed directly in query | |
| 359 | 474 | * |
| 360 | - * @since 1.7 | |
| 475 | + * @since 1.2 | |
| 361 | 476 | * |
| 362 | - * @return array | |
| 477 | + * @param string $type either 'post' or 'term' | |
| 478 | + * @return string join clause | |
| 363 | 479 | */ |
| 364 | - public function get_filtered_taxonomies_query_vars() { | |
| 365 | - $query_vars = array(); | |
| 366 | - foreach ( $this->get_filtered_taxonomies() as $filtered_tax ) { | |
| 367 | - $tax = get_taxonomy( $filtered_tax ); | |
| 368 | - $query_vars[] = $tax->query_var; | |
| 369 | - } | |
| 370 | - return $query_vars; | |
| 480 | + public function join_clause($type) { | |
| 481 | + global $wpdb; | |
| 482 | + return " INNER JOIN $wpdb->term_relationships AS pll_tr ON pll_tr.object_id = " . ('term' == $type ? "t.term_id" : "ID"); | |
| 371 | 483 | } |
| 372 | 484 | |
| 373 | - /** | |
| 374 | - * Create a default category for a language | |
| 485 | + /* | |
| 486 | + * a where clause to add to sql queries when filtering by language is needed directly in query | |
| 375 | 487 | * |
| 376 | 488 | * @since 1.2 |
| 377 | 489 | * |
| 378 | - * @param object|string|int $lang language | |
| 490 | + * @param object|array|string $lang a PLL_Language object or a comma separated list of languag slug or an array of language slugs | |
| 491 | + * @param string $type either 'post' or 'term' | |
| 492 | + * @return string where clause | |
| 379 | 493 | */ |
| 380 | - public function create_default_category( $lang ) { | |
| 381 | - $lang = $this->get_language( $lang ); | |
| 494 | + public function where_clause($lang, $type) { | |
| 495 | + global $wpdb; | |
| 496 | + $tt_id = 'term' == $type ? 'tl_term_taxonomy_id' : 'term_taxonomy_id'; | |
| 382 | 497 | |
| 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 ) ); | |
| 498 | + // $lang is an object | |
| 499 | + // generally the case if the query is coming from Polylang | |
| 500 | + if (is_object($lang)) | |
| 501 | + return $wpdb->prepare(" AND pll_tr.term_taxonomy_id = %d", $lang->$tt_id); | |
| 388 | 502 | |
| 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']; | |
| 503 | + // $lang is a comma separated list of slugs (or an array of slugs) | |
| 504 | + // generally the case is the query is coming from outside with 'lang' parameter | |
| 505 | + $slugs = is_array($lang) ? $lang : explode(',', $lang); | |
| 506 | + foreach ($slugs as $slug) | |
| 507 | + $languages[] = (int) $this->get_language($slug)->$tt_id; | |
| 391 | 508 | |
| 392 | - // set language | |
| 393 | - $this->term->set_language( (int) $cat, $lang ); | |
| 509 | + return " AND pll_tr.term_taxonomy_id IN (" . implode(',', $languages) . ")"; | |
| 510 | + } | |
| 394 | 511 | |
| 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 | - } | |
| 512 | + /* | |
| 513 | + * adds terms clauses to get_terms to filter them by languages - used in both frontend and admin | |
| 514 | + * | |
| 515 | + * @since 1.2 | |
| 516 | + * | |
| 517 | + * @param array $clauses the list of sql clauses in terms query | |
| 518 | + * @param object $lang PLL_Language object | |
| 519 | + * @return array modifed list of clauses | |
| 520 | + */ | |
| 521 | + public function terms_clauses($clauses, $lang) { | |
| 522 | + if (!empty($lang)) { | |
| 523 | + $clauses['join'] .= $this->join_clause('term'); | |
| 524 | + $clauses['where'] .= $this->where_clause($lang, 'term'); | |
| 405 | 525 | } |
| 526 | + return $clauses; | |
| 527 | + } | |
| 406 | 528 | |
| 407 | - $this->term->save_translations( (int) $cat, $translations ); | |
| 529 | + /* | |
| 530 | + * register the language taxonomy | |
| 531 | + * | |
| 532 | + * @since 1.2 | |
| 533 | + */ | |
| 534 | + public function register_taxonomy() { | |
| 535 | + // registers the language taxonomy | |
| 536 | + register_taxonomy('language', $this->get_translated_post_types(), array( | |
| 537 | + 'labels' => array( | |
| 538 | + 'name' => __('Languages', 'polylang'), | |
| 539 | + 'singular_name' => __('Language', 'polylang'), | |
| 540 | + 'all_items' => __('All languages', 'polylang'), | |
| 541 | + ), | |
| 542 | + 'public' => false, // avoid displaying the 'like post tags text box' in the quick edit | |
| 543 | + 'query_var' => 'lang', | |
| 544 | + '_pll' => true // polylang taxonomy | |
| 545 | + )); | |
| 408 | 546 | } |
| 409 | 547 | |
| 410 | - /** | |
| 411 | - * 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 | |
| 548 | + /* | |
| 549 | + * returns post types that need to be translated | |
| 414 | 550 | * |
| 415 | - * @since 1.4 | |
| 551 | + * @since 1.2 | |
| 416 | 552 | * |
| 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 | |
| 553 | + * @param bool $filter true if we should return only valid registered post types | |
| 554 | + * @return array post type names for which Polylang manages languages and translations | |
| 422 | 555 | */ |
| 423 | - public function term_exists( $term_name, $taxonomy, $parent, $language ) { | |
| 424 | - global $wpdb; | |
| 556 | + public function get_translated_post_types($filter = true) { | |
| 557 | + static $post_types = array(); | |
| 425 | 558 | |
| 426 | - $term_name = trim( wp_unslash( $term_name ) ); | |
| 427 | - $term_name = _wp_specialchars( $term_name ); | |
| 559 | + // the post types list is cached for better better performance | |
| 560 | + // wait for 'after_setup_theme' to apply the cache to allow themes adding the filter in functions.php | |
| 561 | + if (!$post_types || !did_action('after_setup_theme')) { | |
| 562 | + $post_types = array('post' => 'post', 'page' => 'page'); | |
| 428 | 563 | |
| 429 | - $select = "SELECT t.term_id FROM $wpdb->terms AS t"; | |
| 430 | - $join = " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id"; | |
| 431 | - $join .= $this->term->join_clause(); | |
| 432 | - $where = $wpdb->prepare( ' WHERE tt.taxonomy = %s AND t.name = %s', $taxonomy, $term_name ); | |
| 433 | - $where .= $this->term->where_clause( $this->get_language( $language ) ); | |
| 564 | + if (!empty($this->options['media_support'])) | |
| 565 | + $post_types['attachement'] = 'attachment'; | |
| 434 | 566 | |
| 435 | - if ( $parent > 0 ) { | |
| 436 | - $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent ); | |
| 567 | + if (is_array($this->options['post_types'])) | |
| 568 | + $post_types = array_merge($post_types, $this->options['post_types']); | |
| 569 | + | |
| 570 | + $post_types = apply_filters('pll_get_post_types', $post_types , false); | |
| 437 | 571 | } |
| 438 | 572 | |
| 439 | - // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared | |
| 440 | - return $wpdb->get_var( $select . $join . $where ); | |
| 573 | + return $filter ? array_intersect($post_types, get_post_types()) : $post_types; | |
| 441 | 574 | } |
| 442 | 575 | |
| 443 | - /** | |
| 444 | - * Checks if a term slug exists in a given language, taxonomy, hierarchy | |
| 576 | + /* | |
| 577 | + * check if registered post type must be translated | |
| 445 | 578 | * |
| 446 | - * @since 1.9 | |
| 447 | - * @since 2.8 Moved from PLL_Share_Term_Slug::term_exists() to PLL_Model::term_exists_by_slug() | |
| 579 | + * @since 1.2 | |
| 448 | 580 | * |
| 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. | |
| 453 | - * @return null|int The term_id of the found term. | |
| 581 | + * @param string $post_type post type name | |
| 454 | 582 | */ |
| 455 | - public function term_exists_by_slug( $slug, $language, $taxonomy = '', $parent = 0 ) { | |
| 456 | - global $wpdb; | |
| 583 | + public function registered_post_type($post_type) { | |
| 584 | + if ($this->is_translated_post_type($post_type)) { | |
| 585 | + register_taxonomy_for_object_type('language', $post_type); | |
| 586 | + register_taxonomy_for_object_type('post_translations', $post_type); | |
| 587 | + } | |
| 588 | + } | |
| 457 | 589 | |
| 458 | - $select = "SELECT t.term_id FROM {$wpdb->terms} AS t"; | |
| 459 | - $join = " INNER JOIN {$wpdb->term_taxonomy} AS tt ON t.term_id = tt.term_id"; | |
| 460 | - $join .= $this->term->join_clause(); | |
| 461 | - $where = $wpdb->prepare( ' WHERE t.slug = %s', $slug ); | |
| 462 | - $where .= $this->term->where_clause( $this->get_language( $language ) ); | |
| 590 | + /* | |
| 591 | + * returns true if Polylang manages languages and translations for this post type | |
| 592 | + * | |
| 593 | + * @since 1.2 | |
| 594 | + * | |
| 595 | + * @param string|array $post_type post type name or array of post type names | |
| 596 | + */ | |
| 597 | + public function is_translated_post_type($post_type) { | |
| 598 | + $post_types = $this->get_translated_post_types(false); | |
| 599 | + return (is_array($post_type) && array_intersect($post_type, $post_types) || in_array($post_type, $post_types)); | |
| 600 | + } | |
| 463 | 601 | |
| 464 | - if ( ! empty( $taxonomy ) ) { | |
| 465 | - $where .= $wpdb->prepare( ' AND tt.taxonomy = %s', $taxonomy ); | |
| 466 | - } | |
| 602 | + /* | |
| 603 | + * return taxonomies that need to be translated | |
| 604 | + * | |
| 605 | + * @since 1.2 | |
| 606 | + * | |
| 607 | + * @param bool $filter true if we should return only valid registered taxonmies | |
| 608 | + * @return array array of registered taxonomy names for which Polylang manages languages and translations | |
| 609 | + */ | |
| 610 | + public function get_translated_taxonomies($filter = true) { | |
| 611 | + static $taxonomies = array(); | |
| 467 | 612 | |
| 468 | - if ( $parent > 0 ) { | |
| 469 | - $where .= $wpdb->prepare( ' AND tt.parent = %d', $parent ); | |
| 613 | + if (!$taxonomies || !did_action('after_setup_theme')) { | |
| 614 | + $taxonomies = array('category' => 'category', 'post_tag' => 'post_tag'); | |
| 615 | + | |
| 616 | + if (is_array($this->options['taxonomies'])) | |
| 617 | + $taxonomies = array_merge($taxonomies, $this->options['taxonomies']); | |
| 618 | + | |
| 619 | + $taxonomies = apply_filters('pll_get_taxonomies', $taxonomies, false); | |
| 470 | 620 | } |
| 471 | 621 | |
| 472 | - // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared | |
| 473 | - return $wpdb->get_var( $select . $join . $where ); | |
| 622 | + return $filter ? array_intersect($taxonomies, get_taxonomies()) : $taxonomies; | |
| 474 | 623 | } |
| 475 | 624 | |
| 625 | + /* | |
| 626 | + * returns true if Polylang manages languages and translations for this post type | |
| 627 | + * | |
| 628 | + * @since 1.2 | |
| 629 | + * | |
| 630 | + * @param string|array $tax taxonomy name or array of taxonomy names | |
| 631 | + */ | |
| 632 | + public function is_translated_taxonomy($tax) { | |
| 633 | + $taxonomies = $this->get_translated_taxonomies(false); | |
| 634 | + return (is_array($tax) && array_intersect($tax, $taxonomies) || in_array($tax, $taxonomies)); | |
| 635 | + } | |
| 476 | 636 | |
| 477 | - /** | |
| 478 | - * Gets the number of posts per language in a date, author or post type archive. | |
| 637 | + /* | |
| 638 | + * it is possible to have several terms with the same name in the same taxonomy (one per language) | |
| 639 | + * but the native term_exists will return true even if only one exists | |
| 640 | + * so here the function adds the language parameter | |
| 479 | 641 | * |
| 480 | - * @since 1.2 | |
| 642 | + * @since 1.4 | |
| 481 | 643 | * |
| 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 ). | |
| 484 | - * @return int | |
| 644 | + * @param string $term_name the term name | |
| 645 | + * @param string $taxonomy taxonomy name | |
| 646 | + * @param int $parent parent term id | |
| 647 | + * @param string|object $language the language slug or object | |
| 648 | + * @return null|int the term_id of the found term | |
| 485 | 649 | */ |
| 486 | - public function count_posts( $lang, $q = array() ) { | |
| 650 | + public function term_exists($term_name, $taxonomy, $parent, $language) { | |
| 487 | 651 | global $wpdb; |
| 488 | 652 | |
| 489 | - $q = wp_parse_args( $q, array( 'post_type' => 'post', 'post_status' => 'publish' ) ); | |
| 653 | + $select = "SELECT t.term_id FROM $wpdb->terms AS t"; | |
| 654 | + $join = " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id"; | |
| 655 | + $join .= $this->join_clause('term'); | |
| 656 | + $where = $wpdb->prepare(" WHERE tt.taxonomy = %s AND t.name = %s", $taxonomy, $term_name); | |
| 657 | + $where .= $this->where_clause($this->get_language($language), 'term'); | |
| 490 | 658 | |
| 491 | - if ( ! is_array( $q['post_type'] ) ) { | |
| 492 | - $q['post_type'] = array( $q['post_type'] ); | |
| 493 | - } | |
| 659 | + if ($parent > 0) | |
| 660 | + $where .= $wpdb->prepare(" AND tt.parent = %d", $parent); | |
| 494 | 661 | |
| 495 | - foreach ( $q['post_type'] as $key => $type ) { | |
| 496 | - if ( ! post_type_exists( $type ) ) { | |
| 497 | - unset( $q['post_type'][ $key ] ); | |
| 498 | - } | |
| 499 | - } | |
| 662 | + return $wpdb->get_var($select . $join . $where); | |
| 663 | + } | |
| 500 | 664 | |
| 501 | - if ( empty( $q['post_type'] ) ) { | |
| 502 | - $q['post_type'] = array( 'post' ); // We *need* a post type. | |
| 503 | - } | |
| 665 | + /* | |
| 666 | + * gets the number of posts per language in a date, author or post type archive | |
| 667 | + * | |
| 668 | + * @since 1.2 | |
| 669 | + * | |
| 670 | + * @param object lang | |
| 671 | + * @param array $args WP_Query arguments (accepted: post_type, m, year, monthnum, day, author, author_name, post_format) | |
| 672 | + * @return int | |
| 673 | + */ | |
| 674 | + public function count_posts($lang, $args = array()) { | |
| 675 | + global $wpdb; | |
| 504 | 676 | |
| 505 | - $cache_key = 'pll_count_posts_' . md5( maybe_serialize( $q ) ); | |
| 506 | - $counts = wp_cache_get( $cache_key, 'counts' ); | |
| 677 | + $q = wp_parse_args($args, array('post_type' => 'post')); | |
| 678 | + if (!is_array($q['post_type'])) | |
| 679 | + $q['post_type'] = array($q['post_type']); | |
| 507 | 680 | |
| 508 | - if ( false === $counts ) { | |
| 509 | - $select = "SELECT pll_tr.term_taxonomy_id, COUNT( * ) AS num_posts FROM {$wpdb->posts}"; | |
| 510 | - $join = $this->post->join_clause(); | |
| 511 | - $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'] ) ) ); | |
| 513 | - $where .= $this->post->where_clause( $this->get_languages_list() ); | |
| 514 | - $groupby = ' GROUP BY pll_tr.term_taxonomy_id'; | |
| 681 | + $cache_key = md5(serialize($q)); | |
| 682 | + $counts = wp_cache_get($cache_key, 'pll_count_posts'); | |
| 515 | 683 | |
| 516 | - if ( ! empty( $q['m'] ) ) { | |
| 517 | - $q['m'] = '' . preg_replace( '|[^0-9]|', '', $q['m'] ); | |
| 518 | - $where .= $wpdb->prepare( " AND YEAR( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 0, 4 ) ); | |
| 519 | - if ( strlen( $q['m'] ) > 5 ) { | |
| 520 | - $where .= $wpdb->prepare( " AND MONTH( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 4, 2 ) ); | |
| 521 | - } | |
| 522 | - if ( strlen( $q['m'] ) > 7 ) { | |
| 523 | - $where .= $wpdb->prepare( " AND DAYOFMONTH( {$wpdb->posts}.post_date ) = %d", substr( $q['m'], 6, 2 ) ); | |
| 524 | - } | |
| 684 | + if (false === $counts) { | |
| 685 | + $select = "SELECT pll_tr.term_taxonomy_id, COUNT(*) AS num_posts FROM {$wpdb->posts} AS p"; | |
| 686 | + $join = $this->join_clause('post'); | |
| 687 | + $where = " WHERE post_status = 'publish'"; | |
| 688 | + $where .= " AND p.post_type IN ('" . join("', '", $q['post_type'] ) . "')"; | |
| 689 | + $where .= $this->where_clause($this->get_languages_list(), 'post'); | |
| 690 | + $groupby = " GROUP BY pll_tr.term_taxonomy_id"; | |
| 691 | + | |
| 692 | + if (!empty($q['m'])) { | |
| 693 | + $q['m'] = '' . preg_replace('|[^0-9]|', '', $q['m']); | |
| 694 | + $where .= $wpdb->prepare(" AND YEAR(p.post_date) = %d", substr($q['m'], 0, 4)); | |
| 695 | + if ( strlen($q['m']) > 5 ) | |
| 696 | + $where .= $wpdb->prepare(" AND MONTH(p.post_date) = %d", substr($q['m'], 4, 2)); | |
| 697 | + if ( strlen($q['m']) > 7 ) | |
| 698 | + $where .= $wpdb->prepare(" AND DAYOFMONTH(p.post_date) = %d", substr($q['m'], 6, 2)); | |
| 525 | 699 | } |
| 526 | 700 | |
| 527 | - if ( ! empty( $q['year'] ) ) { | |
| 528 | - $where .= $wpdb->prepare( " AND YEAR( {$wpdb->posts}.post_date ) = %d", $q['year'] ); | |
| 529 | - } | |
| 701 | + if (!empty($q['year'])) | |
| 702 | + $where .= $wpdb->prepare(" AND YEAR(p.post_date) = %d", $q['year']); | |
| 530 | 703 | |
| 531 | - if ( ! empty( $q['monthnum'] ) ) { | |
| 532 | - $where .= $wpdb->prepare( " AND MONTH( {$wpdb->posts}.post_date ) = %d", $q['monthnum'] ); | |
| 533 | - } | |
| 704 | + if (!empty($q['monthnum'])) | |
| 705 | + $where .= $wpdb->prepare(" AND MONTH(p.post_date) = %d", $q['monthnum']); | |
| 534 | 706 | |
| 535 | - if ( ! empty( $q['day'] ) ) { | |
| 536 | - $where .= $wpdb->prepare( " AND DAYOFMONTH( {$wpdb->posts}.post_date ) = %d", $q['day'] ); | |
| 537 | - } | |
| 707 | + if (!empty($q['day'])) | |
| 708 | + $where .= $wpdb->prepare(" AND DAYOFMONTH(p.post_date) = %d", $q['day']); | |
| 538 | 709 | |
| 539 | - if ( ! empty( $q['author_name'] ) ) { | |
| 540 | - $author = get_user_by( 'slug', sanitize_title_for_query( $q['author_name'] ) ); | |
| 541 | - if ( $author ) { | |
| 710 | + if (!empty($q['author_name'])) { | |
| 711 | + $author = get_user_by('slug', sanitize_title_for_query($q['author_name'])); | |
| 712 | + if ($author) | |
| 542 | 713 | $q['author'] = $author->ID; |
| 543 | - } | |
| 544 | 714 | } |
| 545 | 715 | |
| 546 | - if ( ! empty( $q['author'] ) ) { | |
| 547 | - $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $q['author'] ); | |
| 548 | - } | |
| 716 | + if (!empty($q['author'])) | |
| 717 | + $where .= $wpdb->prepare(" AND p.post_author = %d", $q['author']); | |
| 549 | 718 | |
| 550 | - // Filtered taxonomies ( post_format ). | |
| 551 | - foreach ( $this->get_filtered_taxonomies_query_vars() as $tax_qv ) { | |
| 552 | - | |
| 553 | - if ( ! empty( $q[ $tax_qv ] ) ) { | |
| 554 | - $join .= " INNER JOIN {$wpdb->term_relationships} AS tr ON tr.object_id = {$wpdb->posts}.ID"; | |
| 555 | - $join .= " INNER JOIN {$wpdb->term_taxonomy} AS tt ON tt.term_taxonomy_id = tr.term_taxonomy_id"; | |
| 556 | - $join .= " INNER JOIN {$wpdb->terms} AS t ON t.term_id = tt.term_id"; | |
| 557 | - $where .= $wpdb->prepare( ' AND t.slug = %s', $q[ $tax_qv ] ); | |
| 558 | - } | |
| 719 | + if (!empty($q['post_format'])) { | |
| 720 | + $join .= " INNER JOIN {$wpdb->term_relationships} AS tr ON tr.object_id = p.ID"; | |
| 721 | + $join .= " INNER JOIN {$wpdb->term_taxonomy} AS tt ON tt.term_taxonomy_id = tr.term_taxonomy_id"; | |
| 722 | + $join .= " INNER JOIN {$wpdb->terms} AS t ON t.term_id = tt.term_id"; | |
| 723 | + $where .= $wpdb->prepare(" AND t.slug = %s", $q['post_format']); | |
| 559 | 724 | } |
| 560 | 725 | |
| 561 | - // PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared | |
| 562 | - $res = $wpdb->get_results( $select . $join . $where . $groupby, ARRAY_A ); | |
| 563 | - foreach ( (array) $res as $row ) { | |
| 564 | - $counts[ $row['term_taxonomy_id'] ] = $row['num_posts']; | |
| 565 | - } | |
| 726 | + $res = $wpdb->get_results($select . $join . $where . $groupby, ARRAY_A); | |
| 727 | + foreach ((array) $res as $row) | |
| 728 | + $counts[$row['term_taxonomy_id']] = $row['num_posts']; | |
| 566 | 729 | |
| 567 | - wp_cache_set( $cache_key, $counts, 'counts' ); | |
| 730 | + wp_cache_set($cache_key, $counts, 'pll_count_posts'); | |
| 568 | 731 | } |
| 569 | 732 | |
| 570 | - return empty( $counts[ $lang->term_taxonomy_id ] ) ? 0 : $counts[ $lang->term_taxonomy_id ]; | |
| 733 | + return empty($counts[$lang->term_taxonomy_id]) ? 0 : $counts[$lang->term_taxonomy_id]; | |
| 571 | 734 | } |
| 572 | 735 | |
| 573 | - /** | |
| 574 | - * Setup the links model based on options | |
| 736 | + /* | |
| 737 | + * returns ids of objects in a language similarly to get_objects_in_term for a taxonomy | |
| 738 | + * faster than get_objects_in_term as it avoids a JOIN | |
| 575 | 739 | * |
| 576 | - * @since 1.2 | |
| 740 | + * @since 1.4 | |
| 577 | 741 | * |
| 578 | - * @return object implementing "links_model interface" | |
| 742 | + * @param object $lang a PLL_Language object | |
| 743 | + * @param string $type optional, either 'post' or 'term', defaults to 'post' | |
| 744 | + * @return array | |
| 579 | 745 | */ |
| 580 | - public function get_links_model() { | |
| 581 | - $c = array( 'Directory', 'Directory', 'Subdomain', 'Domain' ); | |
| 582 | - $class = get_option( 'permalink_structure' ) ? 'PLL_Links_' . $c[ $this->options['force_lang'] ] : 'PLL_Links_Default'; | |
| 583 | - | |
| 584 | - /** | |
| 585 | - * Filter the links model class to use | |
| 586 | - * /!\ this filter is fired *before* the $polylang object is available | |
| 587 | - * | |
| 588 | - * @since 2.1.1 | |
| 589 | - * | |
| 590 | - * @param string $class A class name: PLL_Links_Default, PLL_Links_Directory, PLL_Links_Subdomain, PLL_Links_Domain | |
| 591 | - */ | |
| 592 | - $class = apply_filters( 'pll_links_model', $class ); | |
| 593 | - | |
| 594 | - return new $class( $this ); | |
| 595 | - } | |
| 596 | - | |
| 597 | - /** | |
| 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 | - * | |
| 602 | - * @since 1.8 | |
| 603 | - * | |
| 604 | - * @param string $func Function name | |
| 605 | - * @param array $args Function arguments | |
| 606 | - */ | |
| 607 | - public function __call( $func, $args ) { | |
| 608 | - $f = $func; | |
| 609 | - | |
| 610 | - switch ( $func ) { | |
| 611 | - case 'get_object_term': | |
| 612 | - $o = ( false === strpos( $args[1], 'term' ) ) ? 'post' : 'term'; | |
| 613 | - break; | |
| 614 | - | |
| 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; | |
| 623 | - | |
| 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; | |
| 635 | - | |
| 636 | - case 'where_clause': | |
| 637 | - case 'get_objects_in_language': | |
| 638 | - $o = $args[1]; | |
| 639 | - unset( $args[1] ); | |
| 640 | - break; | |
| 641 | - } | |
| 642 | - | |
| 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 | |
| 647 | - | |
| 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 ); | |
| 660 | - } | |
| 661 | - | |
| 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 | - ); | |
| 746 | + public function get_objects_in_language($lang, $type = 'post') { | |
| 747 | + global $wpdb; | |
| 748 | + return $wpdb->get_col($wpdb->prepare(" | |
| 749 | + SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", | |
| 750 | + 'term' == $type ? $lang->tl_term_taxonomy_id : $lang->term_taxonomy_id | |
| 751 | + )); | |
| 672 | 752 | } |
| 673 | 753 | } |
