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