| @@ -1,24 +1,14 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * @package Polylang | |
| 4 | - */ | |
| 5 | 2 | |
| 6 | 3 | /** |
| 7 | 4 | * A class to handle the WPML API based on hooks, introduced since WPML 3.2 |
| 8 | 5 | * It partly relies on the legacy API |
| 9 | - * | |
| 10 | 6 | * @see https://wpml.org/documentation/support/wpml-coding-api/wpml-hooks-reference/ |
| 11 | 7 | * |
| 12 | 8 | * @since 2.0 |
| 13 | 9 | */ |
| 14 | 10 | class PLL_WPML_API { |
| 15 | - /** | |
| 16 | - * Stores the original language when the language is switched. | |
| 17 | - * | |
| 18 | - * @var PLL_Language | |
| 19 | - */ | |
| 20 | - private static $original_language = null; | |
| 21 | 11 | |
| 22 | 12 | /** |
| 23 | 13 | * Constructor |
| 24 | 14 | * |
| @@ -27,94 +17,73 @@ | ||
| 27 | 17 | public function __construct() { |
| 28 | 18 | // Site Wide Language informations |
| 29 | 19 | |
| 30 | 20 | add_filter( 'wpml_active_languages', array( $this, 'wpml_active_languages' ), 10, 2 ); |
| 31 | - add_filter( 'wpml_display_language_names', array( $this, 'wpml_display_language_names' ), 10, 5 ); | |
| 32 | - // wpml_translated_language_name => not applicable | |
| 21 | + // wpml_display_language_names => not implemented | |
| 22 | + // wpml_translated_language_name => not applicable | |
| 33 | 23 | add_filter( 'wpml_current_language', 'pll_current_language', 10, 0 ); |
| 34 | 24 | add_filter( 'wpml_default_language', 'pll_default_language', 10, 0 ); |
| 35 | - // wpml_add_language_selector => not implemented | |
| 36 | - // wpml_footer_language_selector => not applicable | |
| 25 | + // wpml_add_language_selector => not implemented | |
| 26 | + // wpml_footer_language_selector => not applicable | |
| 37 | 27 | add_action( 'wpml_add_language_form_field', array( $this, 'wpml_add_language_form_field' ) ); |
| 38 | 28 | add_filter( 'wpml_language_is_active', array( $this, 'wpml_language_is_active' ), 10, 2 ); |
| 39 | - add_filter( 'wpml_is_rtl', array( $this, 'wpml_is_rtl' ) ); | |
| 40 | - // wpml_language_form_input_field => See wpml_add_language_form_field | |
| 41 | - // wpml_language_has_switched => See wpml_switch_language | |
| 42 | - // wpml_element_trid => not implemented | |
| 43 | - // wpml_get_element_translations => not implemented | |
| 44 | - // wpml_language_switcher => not implemented | |
| 45 | - // wpml_browser_redirect_language_params => not implemented | |
| 46 | - // wpml_enqueue_browser_redirect_language => not applicable | |
| 47 | - // wpml_enqueued_browser_redirect_language => not applicable | |
| 48 | - // wpml_encode_string => not applicable | |
| 49 | - // wpml_decode_string => not applicable | |
| 29 | + add_filter( 'wpml_is_rtl' , array( $this, 'wpml_is_rtl' ) ); | |
| 30 | + // wpml_language_form_input_field => See wpml_add_language_form_field | |
| 31 | + // wpml_language_has_switched => not implemented | |
| 50 | 32 | |
| 51 | 33 | // Retrieving Language Information for Content |
| 52 | 34 | |
| 53 | 35 | add_filter( 'wpml_post_language_details', 'wpml_get_language_information', 10, 2 ); |
| 54 | - add_action( 'wpml_switch_language', array( __CLASS__, 'wpml_switch_language' ), 10, 2 ); | |
| 36 | + // wpml_switch_language => not implemented | |
| 55 | 37 | add_filter( 'wpml_element_language_code', array( $this, 'wpml_element_language_code' ), 10, 3 ); |
| 56 | - // wpml_element_language_details => not applicable | |
| 38 | + // wpml_element_language_details => not applicable | |
| 57 | 39 | |
| 58 | 40 | // Retrieving Localized Content |
| 59 | 41 | |
| 60 | 42 | add_filter( 'wpml_home_url', 'pll_home_url', 10, 0 ); |
| 61 | - add_filter( 'wpml_element_link', 'icl_link_to_element', 10, 7 ); | |
| 43 | + add_filter( 'wpml_element_link', 'icl_link_to_element' , 10, 7 ); | |
| 62 | 44 | add_filter( 'wpml_object_id', 'icl_object_id', 10, 4 ); |
| 63 | 45 | add_filter( 'wpml_translate_single_string', array( $this, 'wpml_translate_single_string' ), 10, 4 ); |
| 64 | - // wpml_translate_string => not applicable | |
| 65 | - // wpml_unfiltered_admin_string => not implemented | |
| 66 | - add_filter( 'wpml_permalink', array( $this, 'wpml_permalink' ), 10, 2 ); | |
| 67 | - // wpml_elements_without_translations => not implemented | |
| 68 | - add_filter( 'wpml_get_translated_slug', array( $this, 'wpml_get_translated_slug' ), 10, 3 ); | |
| 46 | + // wpml_translate_string => not applicable | |
| 47 | + // wpml_unfiltered_admin_string => not implemented | |
| 48 | + add_filter( 'wpml_permalink', array( PLL()->links_model, 'switch_language_in_link' ), 10, 2 ); | |
| 49 | + // wpml_elements_without_translations => not implemented | |
| 50 | + // wpml_get_translated_slug => not implemented | |
| 69 | 51 | |
| 70 | 52 | // Finding the Translation State of Content |
| 71 | 53 | |
| 72 | - // wpml_element_translation_type => not implemented | |
| 54 | + // wpml_element_translation_type | |
| 73 | 55 | add_filter( 'wpml_element_has_translations', array( $this, 'wpml_element_has_translations' ), 10, 3 ); |
| 74 | - // wpml_master_post_from_duplicate => not applicable | |
| 75 | - // wpml_post_duplicates => not applicable | |
| 56 | + // wpml_master_post_from_duplicate => not applicable | |
| 57 | + // wpml_post_duplicates => not applicable | |
| 76 | 58 | |
| 77 | 59 | // Inserting Content |
| 78 | 60 | |
| 79 | - // wpml_admin_make_post_duplicates => not applicable | |
| 80 | - // wpml_make_post_duplicates => not applicable | |
| 61 | + // wpml_admin_make_post_duplicates => not applicable | |
| 62 | + // wpml_make_post_duplicates => not applicable | |
| 81 | 63 | add_action( 'wpml_register_single_string', 'icl_register_string', 10, 3 ); |
| 82 | - // wpml_register_string => not applicable | |
| 83 | - // wpml_register_string_packages => not applicable | |
| 84 | - // wpml_delete_package_action => not applicable | |
| 85 | - // wpml_show_package_language_ui => not applicable | |
| 86 | - // wpml_set_element_language_details => not implemented | |
| 87 | - // wpml_multilingual_options => not applicable | |
| 64 | + // wpml_register_string => not applicable | |
| 65 | + // wpml_register_string_packages => not applicable | |
| 66 | + // wpml_delete_package_action => not applicable | |
| 67 | + // wpml_show_package_language_ui => not applicable | |
| 68 | + // wpml_set_element_language_details => not implemented | |
| 88 | 69 | |
| 89 | 70 | // Miscellaneous |
| 90 | 71 | |
| 91 | - // wpml_element_type => not applicable | |
| 92 | - // wpml_setting => not applicable | |
| 93 | - // wpml_sub_setting => not applicable | |
| 94 | - // wpml_editor_cf_to_display => not applicable | |
| 95 | - // wpml_tm_save_translation_cf => not implemented | |
| 96 | - // wpml_tm_xliff_export_translated_cf => not applicable | |
| 97 | - // wpml_tm_xliff_export_original_cf => not applicable | |
| 98 | - // wpml_duplicate_generic_string => not applicable | |
| 99 | - // wpml_translatable_user_meta_fields => not implemented | |
| 100 | - // wpml_cross_domain_language_data => not applicable | |
| 101 | - // wpml_get_cross_domain_language_data => not applicable | |
| 102 | - // wpml_loaded => not applicable | |
| 103 | - // wpml_st_loaded => not applicable | |
| 104 | - // wpml_tm_loaded => not applicable | |
| 105 | - // wpml_hide_management_column (3.4.1) => not applicable | |
| 106 | - // wpml_ls_directories_to_scan => not applicable | |
| 107 | - // wpml_ls_model_css_classes => not applicable | |
| 108 | - // wpml_ls_model_language_css_classes => not applicable | |
| 109 | - // wpml_tf_feedback_open_link => not applicable | |
| 110 | - // wpml_sync_custom_field => not implemented | |
| 111 | - // wpml_sync_all_custom_fields => not implemented | |
| 112 | - // wpml_is_redirected => not implemented | |
| 113 | - | |
| 114 | - // Updating Content | |
| 115 | - | |
| 116 | - // wpml_set_translation_mode_for_post_type => not implemented | |
| 72 | + // wpml_element_type => not applicable | |
| 73 | + // wpml_setting => not applicable | |
| 74 | + // wpml_sub_setting => not applicable | |
| 75 | + // wpml_editor_cf_to_display => not applicable | |
| 76 | + // wpml_tm_save_translation_cf => not implemented | |
| 77 | + // wpml_tm_xliff_export_translated_cf => not applicable | |
| 78 | + // wpml_tm_xliff_export_original_cf => not applicable | |
| 79 | + // wpml_duplicate_generic_string => not applicable | |
| 80 | + // wpml_translatable_user_meta_fields => not implemented | |
| 81 | + // wpml_cross_domain_language_data => not applicable | |
| 82 | + // wpml_get_cross_domain_language_data => not applicable | |
| 83 | + // wpml_loaded => not applicable | |
| 84 | + // wpml_st_loaded => not applicable | |
| 85 | + // wpml_tm_loaded => not applicable | |
| 117 | 86 | } |
| 118 | 87 | |
| 119 | 88 | /** |
| 120 | 89 | * Get a list of the languages enabled for a site |
| @@ -120,11 +89,11 @@ | ||
| 120 | 89 | * Get a list of the languages enabled for a site |
| 121 | 90 | * |
| 122 | 91 | * @since 2.0 |
| 123 | 92 | * |
| 124 | - * @param mixed $null Not used | |
| 125 | - * @param array| string $args See arguments of icl_get_languages() | |
| 126 | - * @return array Array of arrays per language | |
| 93 | + * @param mixed $null not used | |
| 94 | + * @param array| string $args see arguments of icl_get_languages() | |
| 95 | + * @return array array of arrays per language | |
| 127 | 96 | */ |
| 128 | 97 | public function wpml_active_languages( $null, $args = '' ) { |
| 129 | 98 | return icl_get_languages( $args ); |
| 130 | 99 | } |
| @@ -129,34 +98,17 @@ | ||
| 129 | 98 | return icl_get_languages( $args ); |
| 130 | 99 | } |
| 131 | 100 | |
| 132 | 101 | /** |
| 133 | - * In WPML, get a language's native and translated name for display in a custom language switcher | |
| 134 | - * Since Polylang does not implement the translated name, always returns only the native name, | |
| 135 | - * so the 3rd, 4th and 5th parameters are not used. | |
| 136 | - * | |
| 137 | - * @since 2.2 | |
| 138 | - * | |
| 139 | - * @param mixed $null Not used. | |
| 140 | - * @param string $native_name The language native name. | |
| 141 | - * @return string | |
| 142 | - */ | |
| 143 | - public function wpml_display_language_names( $null, $native_name ) { | |
| 144 | - return $native_name; | |
| 145 | - } | |
| 146 | - | |
| 147 | - /** | |
| 148 | 102 | * Returns an HTML hidden input field with name=”lang” and as value the current language |
| 149 | 103 | * |
| 150 | 104 | * @since 2.0 |
| 151 | - * | |
| 152 | - * @return void | |
| 153 | 105 | */ |
| 154 | 106 | public function wpml_add_language_form_field() { |
| 155 | 107 | $lang = pll_current_language(); |
| 156 | 108 | $field = sprintf( '<input type="hidden" name="lang" value="%s" />', esc_attr( $lang ) ); |
| 157 | 109 | $field = apply_filters( 'wpml_language_form_input_field', $field, $lang ); |
| 158 | - echo $field; // phpcs:ignore WordPress.Security.EscapeOutput | |
| 110 | + echo $field; | |
| 159 | 111 | } |
| 160 | 112 | |
| 161 | 113 | /** |
| 162 | 114 | * Find out if a specific language is enabled for the site |
| @@ -162,10 +114,10 @@ | ||
| 162 | 114 | * Find out if a specific language is enabled for the site |
| 163 | 115 | * |
| 164 | 116 | * @since 2.0 |
| 165 | 117 | * |
| 166 | - * @param mixed $null Not used | |
| 167 | - * @param string $slug Language code | |
| 118 | + * @param mixed $null not used | |
| 119 | + * @param string $slug language code | |
| 168 | 120 | * @return bool |
| 169 | 121 | */ |
| 170 | 122 | public function wpml_language_is_active( $null, $slug ) { |
| 171 | 123 | $language = PLL()->model->get_language( $slug ); |
| @@ -176,51 +128,22 @@ | ||
| 176 | 128 | * Find out whether the current language text direction is RTL or not |
| 177 | 129 | * |
| 178 | 130 | * @since 2.0 |
| 179 | 131 | * |
| 132 | + * @param mixed $null not used | |
| 180 | 133 | * @return bool |
| 181 | 134 | */ |
| 182 | - public function wpml_is_rtl() { | |
| 135 | + public function wpml_is_rtl( $null ) { | |
| 183 | 136 | return pll_current_language( 'is_rtl' ); |
| 184 | 137 | } |
| 185 | 138 | |
| 186 | 139 | /** |
| 187 | - * Switches whole site to the given language or restores the language that was set when first calling this function. | |
| 188 | - * Unlike the WPML original action, it is not possible to set the current language and the cookie to different values. | |
| 189 | - * | |
| 190 | - * @since 2.7 | |
| 191 | - * | |
| 192 | - * @param null|string $lang Language code to switch into, restores the original language if null. | |
| 193 | - * @param bool|string $cookie Optionally also switches the cookie. | |
| 194 | - * @return void | |
| 195 | - */ | |
| 196 | - public static function wpml_switch_language( $lang = null, $cookie = false ) { | |
| 197 | - if ( null === self::$original_language ) { | |
| 198 | - self::$original_language = PLL()->curlang; | |
| 199 | - } | |
| 200 | - | |
| 201 | - if ( empty( $lang ) ) { | |
| 202 | - PLL()->curlang = self::$original_language; | |
| 203 | - } elseif ( 'all' === $lang ) { | |
| 204 | - PLL()->curlang = null; | |
| 205 | - } elseif ( in_array( $lang, pll_languages_list() ) ) { | |
| 206 | - PLL()->curlang = PLL()->model->get_language( $lang ); | |
| 207 | - } | |
| 208 | - | |
| 209 | - if ( $cookie && isset( PLL()->choose_lang ) ) { | |
| 210 | - PLL()->choose_lang->maybe_setcookie(); | |
| 211 | - } | |
| 212 | - | |
| 213 | - do_action( 'wpml_language_has_switched', $lang, $cookie, self::$original_language ); | |
| 214 | - } | |
| 215 | - | |
| 216 | - /** | |
| 217 | 140 | * Get the language code for a translatable element |
| 218 | 141 | * |
| 219 | 142 | * @since 2.0 |
| 220 | 143 | * |
| 221 | 144 | * @param mixed $language_code |
| 222 | - * @param array $args An array with two keys element_id => post_id or term_taxonomy_id, element_type => post type or taxonomy | |
| 145 | + * @param array $args an array with two keys element_id => post_id or term_taxonomy_id, element_type => post type or taxonomy | |
| 223 | 146 | * @return string |
| 224 | 147 | */ |
| 225 | 148 | public function wpml_element_language_code( $language_code, $args ) { |
| 226 | 149 | $type = $args['element_type']; |
| @@ -225,13 +148,10 @@ | ||
| 225 | 148 | public function wpml_element_language_code( $language_code, $args ) { |
| 226 | 149 | $type = $args['element_type']; |
| 227 | 150 | $id = $args['element_id']; |
| 228 | 151 | $pll_type = ( 'post' == $type || pll_is_translated_post_type( $type ) ) ? 'post' : ( 'term' == $type || pll_is_translated_taxonomy( $type ) ? 'term' : false ); |
| 229 | - if ( 'term' === $pll_type ) { | |
| 230 | - $term = get_term_by( 'term_taxonomy_id', $id ); | |
| 231 | - if ( $term instanceof WP_Term ) { | |
| 232 | - $id = $term->term_id; | |
| 233 | - } | |
| 152 | + if ( 'term' === $pll_type && $term = wpcom_vip_get_term_by( 'term_taxonomy_id', $id ) ) { | |
| 153 | + $id = $term->term_id; | |
| 234 | 154 | } |
| 235 | 155 | return $pll_type ? call_user_func( "pll_get_{$pll_type}_language", $id ) : $language_code; |
| 236 | 156 | } |
| 237 | 157 | |
| @@ -239,13 +159,13 @@ | ||
| 239 | 159 | * Translates a string |
| 240 | 160 | * |
| 241 | 161 | * @since 2.0 |
| 242 | 162 | * |
| 243 | - * @param string $string The string's original value | |
| 244 | - * @param string $context The string's registered context | |
| 245 | - * @param string $name The string's registered name | |
| 246 | - * @param null|string $lang Optional, return the translation in this language, defaults to current language | |
| 247 | - * @return string The translated string | |
| 163 | + * @param string $string the string's original value | |
| 164 | + * @param string $context the string's registered context | |
| 165 | + * @param string $name the string's registered name | |
| 166 | + * @param null|string $lang optional, return the translation in this language, defaults to current language | |
| 167 | + * @return string the translated string | |
| 248 | 168 | */ |
| 249 | 169 | public function wpml_translate_single_string( $string, $context, $name, $lang = null ) { |
| 250 | 170 | $has_translation = null; // Passed by reference |
| 251 | 171 | return icl_translate( $context, $name, $string, false, $has_translation, $lang ); |
| @@ -251,55 +171,15 @@ | ||
| 251 | 171 | return icl_translate( $context, $name, $string, false, $has_translation, $lang ); |
| 252 | 172 | } |
| 253 | 173 | |
| 254 | 174 | /** |
| 255 | - * Converts a permalink to a language specific permalink | |
| 256 | - * | |
| 257 | - * @since 2.2 | |
| 258 | - * | |
| 259 | - * @param string $url The url to filter | |
| 260 | - * @param null|string $lang Langage code, optional, defaults to the current language | |
| 261 | - * @return string | |
| 262 | - */ | |
| 263 | - public function wpml_permalink( $url, $lang = '' ) { | |
| 264 | - $lang = PLL()->model->get_language( $lang ); | |
| 265 | - | |
| 266 | - if ( empty( $lang ) && ! empty( PLL()->curlang ) ) { | |
| 267 | - $lang = PLL()->curlang; | |
| 268 | - } | |
| 269 | - | |
| 270 | - return empty( $lang ) ? $url : PLL()->links_model->switch_language_in_link( $url, $lang ); | |
| 271 | - } | |
| 272 | - | |
| 273 | - /** | |
| 274 | - * Translates a post type slug | |
| 275 | - * | |
| 276 | - * @since 2.2 | |
| 277 | - * | |
| 278 | - * @param string $slug Post type slug | |
| 279 | - * @param string $post_type Post type name | |
| 280 | - * @param string $lang Optional language code (defaults to current language) | |
| 281 | - * @return string | |
| 282 | - */ | |
| 283 | - public function wpml_get_translated_slug( $slug, $post_type, $lang = null ) { | |
| 284 | - if ( isset( PLL()->translate_slugs ) ) { | |
| 285 | - if ( empty( $lang ) ) { | |
| 286 | - $lang = pll_current_language(); | |
| 287 | - } | |
| 288 | - | |
| 289 | - $slug = PLL()->translate_slugs->slugs_model->get_translated_slug( $post_type, $lang ); | |
| 290 | - } | |
| 291 | - return $slug; | |
| 292 | - } | |
| 293 | - | |
| 294 | - /** | |
| 295 | 175 | * Find out whether a post type or a taxonomy term is translated |
| 296 | 176 | * |
| 297 | 177 | * @since 2.0 |
| 298 | 178 | * |
| 299 | 179 | * @param mixed $null |
| 300 | - * @param int $id The post_id or term_id | |
| 301 | - * @param string $type The post type or taxonomy | |
| 180 | + * @param int $id post_id or term_id | |
| 181 | + * @param string $type post type or taxonomy | |
| 302 | 182 | * @return bool |
| 303 | 183 | */ |
| 304 | 184 | public function wpml_element_has_translations( $null, $id, $type ) { |
| 305 | 185 | $pll_type = ( 'post' == $type || pll_is_translated_post_type( $type ) ) ? 'post' : ( 'term' == $type || pll_is_translated_taxonomy( $type ) ? 'term' : false ); |
