| @@ -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 | * |
| @@ -15,15 +12,15 @@ | ||
| 15 | 12 | * either strings to display the options or default values |
| 16 | 13 | * |
| 17 | 14 | * @since 0.7 |
| 18 | 15 | * |
| 19 | - * @param string $type optional either 'menu', 'widget' or 'block', defaults to 'widget' | |
| 16 | + * @param string $type optional either 'menu' or 'widget', defaults to 'widget' | |
| 20 | 17 | * @param string $key optional either 'string' or 'default', defaults to 'string' |
| 21 | 18 | * @return array list of switcher options strings or default values |
| 22 | 19 | */ |
| 23 | - public static function get_switcher_options( $type = 'widget', $key = 'string' ) { | |
| 20 | + static public function get_switcher_options( $type = 'widget', $key = 'string' ) { | |
| 24 | 21 | $options = array( |
| 25 | - 'dropdown' => array( 'string' => __( 'Displays as a dropdown', 'polylang' ), 'default' => 0 ), | |
| 22 | + 'dropdown' => array( 'string' => __( 'Displays as dropdown', 'polylang' ), 'default' => 0 ), | |
| 26 | 23 | 'show_names' => array( 'string' => __( 'Displays language names', 'polylang' ), 'default' => 1 ), |
| 27 | 24 | 'show_flags' => array( 'string' => __( 'Displays flags', 'polylang' ), 'default' => 0 ), |
| 28 | 25 | 'force_home' => array( 'string' => __( 'Forces link to front page', 'polylang' ), 'default' => 0 ), |
| 29 | 26 | 'hide_current' => array( 'string' => __( 'Hides the current language', 'polylang' ), 'default' => 0 ), |
| @@ -28,8 +25,9 @@ | ||
| 28 | 25 | 'force_home' => array( 'string' => __( 'Forces link to front page', 'polylang' ), 'default' => 0 ), |
| 29 | 26 | 'hide_current' => array( 'string' => __( 'Hides the current language', 'polylang' ), 'default' => 0 ), |
| 30 | 27 | 'hide_if_no_translation' => array( 'string' => __( 'Hides languages with no translation', 'polylang' ), 'default' => 0 ), |
| 31 | 28 | ); |
| 29 | + | |
| 32 | 30 | return wp_list_pluck( $options, $key ); |
| 33 | 31 | } |
| 34 | 32 | |
| 35 | 33 | /** |
| @@ -34,9 +32,10 @@ | ||
| 34 | 32 | |
| 35 | 33 | /** |
| 36 | 34 | * Get the language elements for use in a walker |
| 37 | 35 | * |
| 38 | - * @see PLL_Switcher::the_languages() for the list of parameters accepted in $args | |
| 36 | + * List of parameters accepted in $args: | |
| 37 | + * @see PLL_Switcher::the_languages | |
| 39 | 38 | * |
| 40 | 39 | * @since 1.2 |
| 41 | 40 | * |
| 42 | 41 | * @param object $links instance of PLL_Frontend_Links |
| @@ -43,10 +42,10 @@ | ||
| 43 | 42 | * @param array $args |
| 44 | 43 | * @return array |
| 45 | 44 | */ |
| 46 | 45 | protected function get_elements( $links, $args ) { |
| 46 | + | |
| 47 | 47 | $first = true; |
| 48 | - $out = array(); | |
| 49 | 48 | |
| 50 | 49 | foreach ( $links->model->get_languages_list( array( 'hide_empty' => $args['hide_if_empty'] ) ) as $language ) { |
| 51 | 50 | $id = (int) $language->term_id; |
| 52 | 51 | $order = (int) $language->term_group; |
| @@ -53,22 +52,26 @@ | ||
| 53 | 52 | $slug = $language->slug; |
| 54 | 53 | $locale = $language->get_locale( 'display' ); |
| 55 | 54 | $classes = array( 'lang-item', 'lang-item-' . $id, 'lang-item-' . esc_attr( $slug ) ); |
| 56 | 55 | $url = null; // Avoids potential notice |
| 57 | - $curlang = 0 === $args['admin_render'] ? $links->curlang->slug : $args['admin_current_lang']; | |
| 58 | - $current_lang = $curlang == $slug; | |
| 59 | 56 | |
| 60 | - if ( $current_lang ) { | |
| 57 | + if ( $first ) { | |
| 58 | + $classes[] = 'lang-item-first'; | |
| 59 | + $first = false; | |
| 60 | + } | |
| 61 | + | |
| 62 | + if ( $current_lang = $links->curlang->slug == $slug ) { | |
| 61 | 63 | if ( $args['hide_current'] && ! ( $args['dropdown'] && ! $args['raw'] ) ) { |
| 62 | 64 | continue; // Hide current language except for dropdown |
| 63 | - } else { | |
| 65 | + } | |
| 66 | + else { | |
| 64 | 67 | $classes[] = 'current-lang'; |
| 65 | 68 | } |
| 66 | 69 | } |
| 67 | 70 | |
| 68 | - if ( null !== $args['post_id'] && ( $tr_id = $links->model->post->get( $args['post_id'], $language ) ) && $links->model->post->current_user_can_read( $tr_id ) ) { | |
| 71 | + if ( null !== $args['post_id'] && ( $tr_id = $links->model->post->get( $args['post_id'], $language ) ) && $links->current_user_can_read( $tr_id ) ) { | |
| 69 | 72 | $url = get_permalink( $tr_id ); |
| 70 | - } elseif ( null === $args['post_id'] && 0 === $args['admin_render'] ) { | |
| 73 | + } elseif ( null === $args['post_id'] ) { | |
| 71 | 74 | $url = $links->get_translation_url( $language ); |
| 72 | 75 | } |
| 73 | 76 | |
| 74 | 77 | if ( $no_translation = empty( $url ) ) { |
| @@ -93,19 +96,14 @@ | ||
| 93 | 96 | |
| 94 | 97 | $url = empty( $url ) || $args['force_home'] ? $links->get_home_url( $language ) : $url; // If the page is not translated, link to the home page |
| 95 | 98 | |
| 96 | 99 | $name = $args['show_names'] || ! $args['show_flags'] || $args['raw'] ? ( 'slug' == $args['display_names_as'] ? $slug : $language->name ) : ''; |
| 97 | - $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 : '' ); | |
| 98 | 101 | |
| 99 | - if ( $first ) { | |
| 100 | - $classes[] = 'lang-item-first'; | |
| 101 | - $first = false; | |
| 102 | - } | |
| 103 | - | |
| 104 | 102 | $out[ $slug ] = compact( 'id', 'order', 'slug', 'locale', 'name', 'url', 'flag', 'current_lang', 'no_translation', 'classes' ); |
| 105 | 103 | } |
| 106 | 104 | |
| 107 | - return $out; | |
| 105 | + return empty( $out ) ? array() : $out; | |
| 108 | 106 | } |
| 109 | 107 | |
| 110 | 108 | /** |
| 111 | 109 | * Displays a language switcher |
| @@ -124,10 +122,8 @@ | ||
| 124 | 122 | * hide_current => hide the current language if set to 1, defaults to 0 |
| 125 | 123 | * post_id => returns links to translations of post defined by post_id if set, defaults not set |
| 126 | 124 | * raw => return a raw array instead of html markup if set to 1, defaults to 0 |
| 127 | 125 | * item_spacing => whether to preserve or discard whitespace between list items, valid options are 'preserve' and 'discard', defaults to preserve |
| 128 | - * 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 | |
| 129 | - * admin_current_lang => the current language code in an admin context. Need to set the admin_render to 1, defaults not set | |
| 130 | 126 | * |
| 131 | 127 | * @since 0.1 |
| 132 | 128 | * |
| 133 | 129 | * @param object $links instance of PLL_Frontend_Links |
| @@ -148,10 +144,8 @@ | ||
| 148 | 144 | 'hide_current' => 0, // don't hide current language |
| 149 | 145 | 'post_id' => null, // if not null, link to translations of post defined by post_id |
| 150 | 146 | 'raw' => 0, // set this to true to build your own custom language switcher |
| 151 | 147 | 'item_spacing' => 'preserve', // 'preserve' or 'discard' whitespace between list items |
| 152 | - 'admin_render' => 0, // make the switcher in an frontend context | |
| 153 | - 'admin_current_lang' => null, // use when admin_render is set to 1, if not null use it instead of the current language | |
| 154 | 148 | ); |
| 155 | 149 | $args = wp_parse_args( $args, $defaults ); |
| 156 | 150 | |
| 157 | 151 | /** |
| @@ -176,9 +170,9 @@ | ||
| 176 | 170 | |
| 177 | 171 | if ( $args['dropdown'] ) { |
| 178 | 172 | $args['name'] = 'lang_choice_' . $args['dropdown']; |
| 179 | 173 | $walker = new PLL_Walker_Dropdown(); |
| 180 | - $args['selected'] = 0 === $args['admin_render'] ? $links->curlang->slug : $args['admin_current_lang']; | |
| 174 | + $args['selected'] = $links->curlang->slug; | |
| 181 | 175 | } |
| 182 | 176 | else { |
| 183 | 177 | $walker = new PLL_Walker_List(); |
| 184 | 178 | } |
| @@ -190,15 +184,20 @@ | ||
| 190 | 184 | * |
| 191 | 185 | * @param string $html html returned/outputted by the template tag |
| 192 | 186 | * @param array $args arguments passed to the template tag |
| 193 | 187 | */ |
| 194 | - $out = apply_filters( 'pll_the_languages', $walker->walk( $elements, -1, $args ), $args ); | |
| 188 | + $out = apply_filters( 'pll_the_languages', $walker->walk( $elements, $args ), $args ); | |
| 195 | 189 | |
| 196 | 190 | // Javascript to switch the language when using a dropdown list |
| 197 | - if ( $args['dropdown'] && 0 === $args['admin_render'] ) { | |
| 191 | + if ( $args['dropdown'] ) { | |
| 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 | + | |
| 198 | 197 | // Accept only few valid characters for the urls_x variable name ( as the widget id includes '-' which is invalid ) |
| 199 | - $out .= sprintf( | |
| 200 | - '<script type="text/javascript"> | |
| 198 | + $out .= sprintf( ' | |
| 199 | + <script type="text/javascript"> | |
| 201 | 200 | //<![CDATA[ |
| 202 | 201 | var %1$s = %2$s; |
| 203 | 202 | document.getElementById( "%3$s" ).onchange = function() { |
| 204 | 203 | location.href = %1$s[this.value]; |
| @@ -204,16 +203,14 @@ | ||
| 204 | 203 | location.href = %1$s[this.value]; |
| 205 | 204 | } |
| 206 | 205 | //]]> |
| 207 | 206 | </script>', |
| 208 | - 'urls_' . preg_replace( '#[^a-zA-Z0-9]#', '', $args['dropdown'] ), | |
| 209 | - wp_json_encode( wp_list_pluck( $elements, 'url' ) ), | |
| 210 | - esc_js( $args['name'] ) | |
| 207 | + 'urls_' . preg_replace( '#[^a-zA-Z0-9]#', '', $args['dropdown'] ), json_encode( $urls ), esc_js( $args['name'] ) | |
| 211 | 208 | ); |
| 212 | 209 | } |
| 213 | 210 | |
| 214 | 211 | if ( $args['echo'] ) { |
| 215 | - echo $out; // phpcs:ignore WordPress.Security.EscapeOutput | |
| 212 | + echo $out; | |
| 216 | 213 | } |
| 217 | 214 | return $out; |
| 218 | 215 | } |
| 219 | 216 | } |
