| @@ -1,5 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | 7 | * A class to display a language switcher on frontend |
| 5 | 8 | * |
| @@ -5,16 +8,37 @@ | ||
| 5 | 8 | * |
| 6 | 9 | * @since 1.2 |
| 7 | 10 | */ |
| 8 | 11 | class PLL_Switcher { |
| 12 | + public const DEFAULTS = array( | |
| 13 | + 'dropdown' => 0, // Display as list and not as dropdown. | |
| 14 | + 'echo' => 1, // Echoes the list. | |
| 15 | + 'hide_if_empty' => 1, // Hides languages with no posts (or pages). | |
| 16 | + 'show_flags' => 0, // Don't show flags. | |
| 17 | + 'show_names' => 1, // Show language names. | |
| 18 | + 'display_names_as' => 'name', // Display the language name. | |
| 19 | + 'force_home' => 0, // Tries to find a translation. | |
| 20 | + 'hide_if_no_translation' => 0, // Don't hide the link if there is no translation. | |
| 21 | + 'hide_current' => 0, // Don't hide the current language. | |
| 22 | + 'post_id' => null, // Link to the translations of the current page. | |
| 23 | + 'raw' => 0, // Build the language switcher. | |
| 24 | + 'item_spacing' => 'preserve', // Preserve whitespace between list items. | |
| 25 | + 'admin_render' => 0, // Make the switcher in a frontend context. | |
| 26 | + 'admin_current_lang' => null, // Use the global current language. | |
| 27 | + ); | |
| 9 | 28 | |
| 10 | 29 | /** |
| 30 | + * @var PLL_Links|null | |
| 31 | + */ | |
| 32 | + protected $links; | |
| 33 | + | |
| 34 | + /** | |
| 11 | 35 | * Returns options available for the language switcher - menu or widget |
| 12 | 36 | * either strings to display the options or default values |
| 13 | 37 | * |
| 14 | 38 | * @since 0.7 |
| 15 | 39 | * |
| 16 | - * @param string $type optional either 'menu' or 'widget', defaults to 'widget' | |
| 40 | + * @param string $type optional either 'menu', 'widget' or 'block', defaults to 'widget' | |
| 17 | 41 | * @param string $key optional either 'string' or 'default', defaults to 'string' |
| 18 | 42 | * @return array list of switcher options strings or default values |
| 19 | 43 | */ |
| 20 | 44 | public static function get_switcher_options( $type = 'widget', $key = 'string' ) { |
| @@ -25,36 +49,96 @@ | ||
| 25 | 49 | 'force_home' => array( 'string' => __( 'Forces link to front page', 'polylang' ), 'default' => 0 ), |
| 26 | 50 | 'hide_current' => array( 'string' => __( 'Hides the current language', 'polylang' ), 'default' => 0 ), |
| 27 | 51 | 'hide_if_no_translation' => array( 'string' => __( 'Hides languages with no translation', 'polylang' ), 'default' => 0 ), |
| 28 | 52 | ); |
| 53 | + return wp_list_pluck( $options, $key ); | |
| 54 | + } | |
| 29 | 55 | |
| 30 | - return wp_list_pluck( $options, $key ); | |
| 56 | + /** | |
| 57 | + * Returns the current language code. | |
| 58 | + * | |
| 59 | + * @since 3.0 | |
| 60 | + * | |
| 61 | + * @param array $args Arguments passed to {@see PLL_Switcher::the_languages()}. | |
| 62 | + * @return string | |
| 63 | + */ | |
| 64 | + protected function get_current_language( $args ) { | |
| 65 | + if ( $args['admin_current_lang'] ) { | |
| 66 | + return $args['admin_current_lang']; | |
| 67 | + } | |
| 68 | + | |
| 69 | + if ( isset( $this->links->curlang ) ) { | |
| 70 | + return $this->links->curlang->slug; | |
| 71 | + } | |
| 72 | + | |
| 73 | + return $this->links->options['default_lang']; | |
| 31 | 74 | } |
| 32 | 75 | |
| 33 | 76 | /** |
| 77 | + * Returns the link for a given language. | |
| 78 | + * | |
| 79 | + * @since 3.0 | |
| 80 | + * | |
| 81 | + * @param PLL_Language $language Language. | |
| 82 | + * @param array $args Arguments passed to {@see PLL_Switcher::the_languages()}. | |
| 83 | + * @return string|null | |
| 84 | + */ | |
| 85 | + protected function get_link( $language, $args ) { | |
| 86 | + global $post; | |
| 87 | + | |
| 88 | + // Priority to the post passed in parameters. | |
| 89 | + if ( null !== $args['post_id'] ) { | |
| 90 | + $tr_id = $this->links->model->post->get( $args['post_id'], $language ); | |
| 91 | + if ( $tr_id && $this->links->model->post->current_user_can_read( $tr_id ) ) { | |
| 92 | + return get_permalink( $tr_id ); | |
| 93 | + } | |
| 94 | + } | |
| 95 | + | |
| 96 | + // If we are on frontend. | |
| 97 | + if ( $this->links instanceof PLL_Frontend_Links ) { | |
| 98 | + return $this->links->get_translation_url( $language ); | |
| 99 | + } | |
| 100 | + | |
| 101 | + // For blocks in posts in REST requests. | |
| 102 | + if ( $post instanceof WP_Post ) { | |
| 103 | + $tr_id = $this->links->model->post->get( $post->ID, $language ); | |
| 104 | + if ( $tr_id && $this->links->model->post->current_user_can_read( $tr_id ) ) { | |
| 105 | + return get_permalink( $tr_id ); | |
| 106 | + } | |
| 107 | + } | |
| 108 | + | |
| 109 | + return null; | |
| 110 | + } | |
| 111 | + | |
| 112 | + /** | |
| 34 | 113 | * Get the language elements for use in a walker |
| 35 | 114 | * |
| 36 | - * @see list of parameters accepted in $args documented for PLL_Switcher::the_languages | |
| 37 | - * | |
| 38 | 115 | * @since 1.2 |
| 39 | 116 | * |
| 40 | - * @param object $links instance of PLL_Frontend_Links | |
| 41 | - * @param array $args | |
| 42 | - * @return array | |
| 117 | + * @param array $args Arguments passed to {@see PLL_Switcher::the_languages()}. | |
| 118 | + * @return array Language switcher elements. | |
| 43 | 119 | */ |
| 44 | - protected function get_elements( $links, $args ) { | |
| 120 | + protected function get_elements( $args ) { | |
| 45 | 121 | $first = true; |
| 46 | 122 | $out = array(); |
| 47 | 123 | |
| 48 | - foreach ( $links->model->get_languages_list( array( 'hide_empty' => $args['hide_if_empty'] ) ) as $language ) { | |
| 49 | - $id = (int) $language->term_id; | |
| 50 | - $order = (int) $language->term_group; | |
| 51 | - $slug = $language->slug; | |
| 52 | - $locale = $language->get_locale( 'display' ); | |
| 53 | - $classes = array( 'lang-item', 'lang-item-' . $id, 'lang-item-' . esc_attr( $slug ) ); | |
| 54 | - $url = null; // Avoids potential notice | |
| 124 | + foreach ( $this->links->model->get_languages_list( array( 'hide_empty' => $args['hide_if_empty'] ) ) as $language ) { | |
| 125 | + $id = (int) $language->term_id; | |
| 126 | + $order = (int) $language->term_group; | |
| 127 | + $slug = $language->slug; | |
| 128 | + $locale = $language->get_locale( 'display' ); | |
| 129 | + $is_rtl = $language->is_rtl; | |
| 130 | + $item_classes = array( 'lang-item', 'lang-item-' . $id, 'lang-item-' . esc_attr( $slug ) ); | |
| 131 | + $classes = isset( $args['classes'] ) && is_array( $args['classes'] ) ? | |
| 132 | + array_merge( | |
| 133 | + $item_classes, | |
| 134 | + $args['classes'] | |
| 135 | + ) : | |
| 136 | + $item_classes; | |
| 137 | + $link_classes = $args['link_classes'] ?? array(); | |
| 138 | + $current_lang = $this->get_current_language( $args ) === $slug; | |
| 55 | 139 | |
| 56 | - if ( $current_lang = $links->curlang->slug == $slug ) { | |
| 140 | + if ( $current_lang ) { | |
| 57 | 141 | if ( $args['hide_current'] && ! ( $args['dropdown'] && ! $args['raw'] ) ) { |
| 58 | 142 | continue; // Hide current language except for dropdown |
| 59 | 143 | } else { |
| 60 | 144 | $classes[] = 'current-lang'; |
| @@ -60,13 +144,9 @@ | ||
| 60 | 144 | $classes[] = 'current-lang'; |
| 61 | 145 | } |
| 62 | 146 | } |
| 63 | 147 | |
| 64 | - if ( null !== $args['post_id'] && ( $tr_id = $links->model->post->get( $args['post_id'], $language ) ) && $links->model->post->current_user_can_read( $tr_id ) ) { | |
| 65 | - $url = get_permalink( $tr_id ); | |
| 66 | - } elseif ( null === $args['post_id'] ) { | |
| 67 | - $url = $links->get_translation_url( $language ); | |
| 68 | - } | |
| 148 | + $url = $this->get_link( $language, $args ); | |
| 69 | 149 | |
| 70 | 150 | if ( $no_translation = empty( $url ) ) { |
| 71 | 151 | $classes[] = 'no-translation'; |
| 72 | 152 | } |
| @@ -75,11 +155,11 @@ | ||
| 75 | 155 | * Filter the link in the language switcher |
| 76 | 156 | * |
| 77 | 157 | * @since 0.7 |
| 78 | 158 | * |
| 79 | - * @param string $url the link | |
| 80 | - * @param string $slug language code | |
| 81 | - * @param string $locale language locale | |
| 159 | + * @param string|null $url The link, null if no translation was found. | |
| 160 | + * @param string $slug The language code. | |
| 161 | + * @param string $locale The language locale | |
| 82 | 162 | */ |
| 83 | 163 | $url = apply_filters( 'pll_the_language_link', $url, $slug, $language->locale ); |
| 84 | 164 | |
| 85 | 165 | // Hide if no translation exists |
| @@ -86,19 +166,26 @@ | ||
| 86 | 166 | if ( empty( $url ) && $args['hide_if_no_translation'] ) { |
| 87 | 167 | continue; |
| 88 | 168 | } |
| 89 | 169 | |
| 90 | - $url = empty( $url ) || $args['force_home'] ? $links->get_home_url( $language ) : $url; // If the page is not translated, link to the home page | |
| 170 | + $url = empty( $url ) || $args['force_home'] ? $this->links->get_home_url( $language ) : $url; // If the page is not translated, link to the home page | |
| 91 | 171 | |
| 92 | 172 | $name = $args['show_names'] || ! $args['show_flags'] || $args['raw'] ? ( 'slug' == $args['display_names_as'] ? $slug : $language->name ) : ''; |
| 93 | - $flag = $args['raw'] && ! $args['show_flags'] ? $language->flag_url : ( $args['show_flags'] ? $language->flag : '' ); | |
| 94 | 173 | |
| 174 | + if ( $args['raw'] && ! $args['show_flags'] ) { | |
| 175 | + $flag = $language->get_display_flag_url(); | |
| 176 | + } elseif ( $args['show_flags'] ) { | |
| 177 | + $flag = $language->get_display_flag( empty( $args['show_names'] ) ? 'alt' : 'no-alt' ); | |
| 178 | + } else { | |
| 179 | + $flag = ''; | |
| 180 | + } | |
| 181 | + | |
| 95 | 182 | if ( $first ) { |
| 96 | 183 | $classes[] = 'lang-item-first'; |
| 97 | 184 | $first = false; |
| 98 | 185 | } |
| 99 | 186 | |
| 100 | - $out[ $slug ] = compact( 'id', 'order', 'slug', 'locale', 'name', 'url', 'flag', 'current_lang', 'no_translation', 'classes' ); | |
| 187 | + $out[ $slug ] = compact( 'id', 'order', 'slug', 'locale', 'is_rtl', 'name', 'url', 'flag', 'current_lang', 'no_translation', 'classes', 'link_classes' ); | |
| 101 | 188 | } |
| 102 | 189 | |
| 103 | 190 | return $out; |
| 104 | 191 | } |
| @@ -104,49 +191,40 @@ | ||
| 104 | 191 | } |
| 105 | 192 | |
| 106 | 193 | /** |
| 107 | 194 | * Displays a language switcher |
| 108 | - * or returns the raw elements to build a custom language switcher | |
| 195 | + * or returns the raw elements to build a custom language switcher. | |
| 109 | 196 | * |
| 110 | - * List of parameters accepted in $args: | |
| 197 | + * @since 0.1 | |
| 111 | 198 | * |
| 112 | - * dropdown => the list is displayed as dropdown if set, defaults to 0 | |
| 113 | - * echo => echoes the list if set to 1, defaults to 1 | |
| 114 | - * hide_if_empty => hides languages with no posts ( or pages ) if set to 1, defaults to 1 | |
| 115 | - * show_flags => displays flags if set to 1, defaults to 0 | |
| 116 | - * show_names => show language names if set to 1, defaults to 1 | |
| 117 | - * display_names_as => whether to display the language name or its slug, valid options are 'slug' and 'name', defaults to name | |
| 118 | - * force_home => will always link to home in translated language if set to 1, defaults to 0 | |
| 119 | - * hide_if_no_translation => hide the link if there is no translation if set to 1, defaults to 0 | |
| 120 | - * hide_current => hide the current language if set to 1, defaults to 0 | |
| 121 | - * post_id => returns links to translations of post defined by post_id if set, defaults not set | |
| 122 | - * raw => return a raw array instead of html markup if set to 1, defaults to 0 | |
| 123 | - * item_spacing => whether to preserve or discard whitespace between list items, valid options are 'preserve' and 'discard', defaults to preserve | |
| 199 | + * @param PLL_Links $links Instance of PLL_Links. | |
| 200 | + * @param array $args { | |
| 201 | + * Optional array of arguments. | |
| 124 | 202 | * |
| 125 | - * @since 0.1 | |
| 126 | - * | |
| 127 | - * @param object $links instance of PLL_Frontend_Links | |
| 128 | - * @param array $args | |
| 203 | + * @type int $dropdown The list is displayed as dropdown if set, defaults to 0. | |
| 204 | + * @type int $echo Echoes the list if set to 1, defaults to 1. | |
| 205 | + * @type int $hide_if_empty Hides languages with no posts ( or pages ) if set to 1, defaults to 1. | |
| 206 | + * @type int $show_flags Displays flags if set to 1, defaults to 0. | |
| 207 | + * @type int $show_names Shows language names if set to 1, defaults to 1. | |
| 208 | + * @type string $display_names_as Whether to display the language name or its slug, valid options are 'slug' and 'name', defaults to name. | |
| 209 | + * @type int $force_home Will always link to home in translated language if set to 1, defaults to 0. | |
| 210 | + * @type int $hide_if_no_translation Hides the link if there is no translation if set to 1, defaults to 0. | |
| 211 | + * @type int $hide_current Hides the current language if set to 1, defaults to 0. | |
| 212 | + * @type int $post_id Returns links to the translations of the post defined by post_id if set, defaults not set. | |
| 213 | + * @type int $raw Return a raw array instead of html markup if set to 1, defaults to 0. | |
| 214 | + * @type string $item_spacing Whether to preserve or discard whitespace between list items, valid options are 'preserve' and 'discard', defaults to 'preserve'. | |
| 215 | + * @type int $admin_render Allows to force the current language code in an admin context if set, default to 0. Need to set the admin_current_lang argument below. | |
| 216 | + * @type string $admin_current_lang The current language code in an admin context. Need to set the admin_render to 1, defaults not set. | |
| 217 | + * @type string[] $classes A list of CSS classes to set to each elements outputted. | |
| 218 | + * @type string[] $link_classes A list of CSS classes to set to each link outputted. | |
| 219 | + * } | |
| 129 | 220 | * @return string|array either the html markup of the switcher or the raw elements to build a custom language switcher |
| 130 | 221 | */ |
| 131 | - public function the_languages( $links, $args = '' ) { | |
| 132 | - $defaults = array( | |
| 133 | - 'dropdown' => 0, // display as list and not as dropdown | |
| 134 | - 'echo' => 1, // echoes the list | |
| 135 | - 'hide_if_empty' => 1, // hides languages with no posts ( or pages ) | |
| 136 | - 'menu' => 0, // not for nav menu ( this argument is deprecated since v1.1.1 ) | |
| 137 | - 'show_flags' => 0, // don't show flags | |
| 138 | - 'show_names' => 1, // show language names | |
| 139 | - 'display_names_as' => 'name', // valid options are slug and name | |
| 140 | - 'force_home' => 0, // tries to find a translation | |
| 141 | - 'hide_if_no_translation' => 0, // don't hide the link if there is no translation | |
| 142 | - 'hide_current' => 0, // don't hide current language | |
| 143 | - 'post_id' => null, // if not null, link to translations of post defined by post_id | |
| 144 | - 'raw' => 0, // set this to true to build your own custom language switcher | |
| 145 | - 'item_spacing' => 'preserve', // 'preserve' or 'discard' whitespace between list items | |
| 146 | - ); | |
| 147 | - $args = wp_parse_args( $args, $defaults ); | |
| 222 | + public function the_languages( $links, $args = array() ) { | |
| 148 | 223 | |
| 224 | + $this->links = $links; | |
| 225 | + $args = wp_parse_args( $args, self::DEFAULTS ); | |
| 226 | + | |
| 149 | 227 | /** |
| 150 | 228 | * Filter the arguments of the 'pll_the_languages' template tag |
| 151 | 229 | * |
| 152 | 230 | * @since 1.5 |
| @@ -154,14 +232,19 @@ | ||
| 154 | 232 | * @param array $args |
| 155 | 233 | */ |
| 156 | 234 | $args = apply_filters( 'pll_the_languages_args', $args ); |
| 157 | 235 | |
| 158 | - // Prevents showing empty options in dropdown | |
| 159 | - if ( $args['dropdown'] ) { | |
| 236 | + // Force not to hide the language for the widget preview even if the option is checked. | |
| 237 | + if ( $this->links instanceof PLL_Admin_Links ) { | |
| 238 | + $args['hide_if_no_translation'] = 0; | |
| 239 | + } | |
| 240 | + | |
| 241 | + // Prevents showing empty options in `<select>`. | |
| 242 | + if ( $args['dropdown'] && ! $args['raw'] ) { | |
| 160 | 243 | $args['show_names'] = 1; |
| 161 | 244 | } |
| 162 | 245 | |
| 163 | - $elements = $this->get_elements( $links, $args ); | |
| 246 | + $elements = $this->get_elements( $args ); | |
| 164 | 247 | |
| 165 | 248 | if ( $args['raw'] ) { |
| 166 | 249 | return $elements; |
| 167 | 250 | } |
| @@ -167,13 +250,19 @@ | ||
| 167 | 250 | } |
| 168 | 251 | |
| 169 | 252 | if ( $args['dropdown'] ) { |
| 170 | 253 | $args['name'] = 'lang_choice_' . $args['dropdown']; |
| 254 | + $args['class'] = 'pll-switcher-select'; | |
| 255 | + $args['value'] = 'url'; | |
| 256 | + $args['selected'] = $this->get_link( $this->links->model->get_language( $this->get_current_language( $args ) ), $args ); | |
| 171 | 257 | $walker = new PLL_Walker_Dropdown(); |
| 172 | - $args['selected'] = $links->curlang->slug; | |
| 258 | + } else { | |
| 259 | + $walker = new PLL_Walker_List(); | |
| 173 | 260 | } |
| 174 | - else { | |
| 175 | - $walker = new PLL_Walker_List(); | |
| 261 | + | |
| 262 | + // Cast each element to stdClass because $walker::walk() expects an array of objects. | |
| 263 | + foreach ( $elements as $i => $element ) { | |
| 264 | + $elements[ $i ] = (object) $element; | |
| 176 | 265 | } |
| 177 | 266 | |
| 178 | 267 | /** |
| 179 | 268 | * Filter the whole html markup returned by the 'pll_the_languages' template tag |
| @@ -184,29 +273,16 @@ | ||
| 184 | 273 | * @param array $args arguments passed to the template tag |
| 185 | 274 | */ |
| 186 | 275 | $out = apply_filters( 'pll_the_languages', $walker->walk( $elements, -1, $args ), $args ); |
| 187 | 276 | |
| 188 | - // Javascript to switch the language when using a dropdown list | |
| 189 | - if ( $args['dropdown'] ) { | |
| 190 | - $urls = array(); | |
| 191 | - | |
| 192 | - foreach ( $links->model->get_languages_list() as $language ) { | |
| 193 | - $url = $links->get_translation_url( $language ); | |
| 194 | - $urls[ $language->slug ] = $args['force_home'] || empty( $url ) ? $links->get_home_url( $language ) : $url; | |
| 195 | - } | |
| 196 | - | |
| 197 | - // Accept only few valid characters for the urls_x variable name ( as the widget id includes '-' which is invalid ) | |
| 277 | + // Javascript to switch the language when using a dropdown list. | |
| 278 | + if ( $args['dropdown'] && 0 === $args['admin_render'] ) { | |
| 279 | + // Accept only few valid characters for the urls_x variable name (as the widget id includes '-' which is invalid). | |
| 198 | 280 | $out .= sprintf( |
| 199 | - '<script type="text/javascript"> | |
| 200 | - //<![CDATA[ | |
| 201 | - var %1$s = %2$s; | |
| 202 | - document.getElementById( "%3$s" ).onchange = function() { | |
| 203 | - location.href = %1$s[this.value]; | |
| 204 | - } | |
| 205 | - //]]> | |
| 281 | + '<script%1$s> | |
| 282 | + document.getElementById( "%2$s" ).addEventListener( "change", function ( event ) { location.href = event.currentTarget.value; } ) | |
| 206 | 283 | </script>', |
| 207 | - 'urls_' . preg_replace( '#[^a-zA-Z0-9]#', '', $args['dropdown'] ), | |
| 208 | - wp_json_encode( $urls ), | |
| 284 | + current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"', | |
| 209 | 285 | esc_js( $args['name'] ) |
| 210 | 286 | ); |
| 211 | 287 | } |
| 212 | 288 | |
