| @@ -1,38 +1,48 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | - * Links model for default permalinks | |
| 5 | - * for example mysite.com/?somevar=something&lang=en | |
| 6 | - * implements the "links_model interface" | |
| 7 | + * Links model for the default permalinks | |
| 8 | + * for example mysite.com/?somevar=something&lang=en. | |
| 7 | 9 | * |
| 8 | 10 | * @since 1.2 |
| 9 | 11 | */ |
| 10 | 12 | class PLL_Links_Default extends PLL_Links_Model { |
| 13 | + /** | |
| 14 | + * Tells this child class of PLL_Links_Model does not use pretty permalinks. | |
| 15 | + * | |
| 16 | + * @var bool | |
| 17 | + */ | |
| 11 | 18 | public $using_permalinks = false; |
| 12 | 19 | |
| 13 | 20 | /** |
| 14 | - * Adds language information to an url | |
| 15 | - * links_model interface | |
| 21 | + * Adds the language code in a url. | |
| 16 | 22 | * |
| 17 | 23 | * @since 1.2 |
| 24 | + * @since 3.4 Accepts now a language slug. | |
| 18 | 25 | * |
| 19 | - * @param string $url url to modify | |
| 20 | - * @param object $lang language | |
| 21 | - * @return string modified url | |
| 26 | + * @param string $url The url to modify. | |
| 27 | + * @param PLL_Language|string|false $language Language object or slug. | |
| 28 | + * @return string The modified url. | |
| 22 | 29 | */ |
| 23 | - public function add_language_to_link( $url, $lang ) { | |
| 24 | - return empty( $lang ) || ( $this->options['hide_default'] && $this->options['default_lang'] == $lang->slug ) ? $url : add_query_arg( 'lang', $lang->slug, $url ); | |
| 30 | + public function add_language_to_link( $url, $language ) { | |
| 31 | + if ( $language instanceof PLL_Language ) { | |
| 32 | + $language = $language->slug; | |
| 33 | + } | |
| 34 | + | |
| 35 | + return empty( $language ) || ( $this->options['hide_default'] && $this->options['default_lang'] === $language ) ? $url : add_query_arg( 'lang', $language, $url ); | |
| 25 | 36 | } |
| 26 | 37 | |
| 27 | 38 | /** |
| 28 | - * Removes the language information from an url | |
| 29 | - * links_model interface | |
| 39 | + * Removes the language information from an url. | |
| 30 | 40 | * |
| 31 | 41 | * @since 1.2 |
| 32 | 42 | * |
| 33 | - * @param string $url url to modify | |
| 34 | - * @return string modified url | |
| 43 | + * @param string $url The url to modify. | |
| 44 | + * @return string The modified url. | |
| 35 | 45 | */ |
| 36 | 46 | public function remove_language_from_link( $url ) { |
| 37 | 47 | return remove_query_arg( 'lang', $url ); |
| 38 | 48 | } |
| @@ -37,15 +47,14 @@ | ||
| 37 | 47 | return remove_query_arg( 'lang', $url ); |
| 38 | 48 | } |
| 39 | 49 | |
| 40 | 50 | /** |
| 41 | - * Returns the link to the first page | |
| 42 | - * links_model interface | |
| 51 | + * Returns the link to the first page. | |
| 43 | 52 | * |
| 44 | 53 | * @since 1.2 |
| 45 | 54 | * |
| 46 | - * @param string $url url to modify | |
| 47 | - * @return string modified url | |
| 55 | + * @param string $url The url to modify. | |
| 56 | + * @return string The modified url. | |
| 48 | 57 | */ |
| 49 | 58 | public function remove_paged_from_link( $url ) { |
| 50 | 59 | return remove_query_arg( 'paged', $url ); |
| 51 | 60 | } |
| @@ -50,15 +59,15 @@ | ||
| 50 | 59 | return remove_query_arg( 'paged', $url ); |
| 51 | 60 | } |
| 52 | 61 | |
| 53 | 62 | /** |
| 54 | - * Returns the link to the paged page when using pretty permalinks | |
| 63 | + * Returns the link to the paged page. | |
| 55 | 64 | * |
| 56 | 65 | * @since 1.5 |
| 57 | 66 | * |
| 58 | - * @param string $url url to modify | |
| 59 | - * @param int $page | |
| 60 | - * @return string modified url | |
| 67 | + * @param string $url The url to modify. | |
| 68 | + * @param int $page The page number. | |
| 69 | + * @return string The modified url. | |
| 61 | 70 | */ |
| 62 | 71 | public function add_paged_to_link( $url, $page ) { |
| 63 | 72 | return add_query_arg( array( 'paged' => $page ), $url ); |
| 64 | 73 | } |
| @@ -63,16 +72,15 @@ | ||
| 63 | 72 | return add_query_arg( array( 'paged' => $page ), $url ); |
| 64 | 73 | } |
| 65 | 74 | |
| 66 | 75 | /** |
| 67 | - * Gets the language slug from the url if present | |
| 68 | - * links_model interface | |
| 76 | + * Gets the language slug from the url if present. | |
| 69 | 77 | * |
| 70 | 78 | * @since 1.2 |
| 71 | - * @since 2.0 add $url argument | |
| 79 | + * @since 2.0 Add the $url argument. | |
| 72 | 80 | * |
| 73 | - * @param string $url optional, defaults to current url | |
| 74 | - * @return string language slug | |
| 81 | + * @param string $url Optional, defaults to the current url. | |
| 82 | + * @return string Language slug. | |
| 75 | 83 | */ |
| 76 | 84 | public function get_language_from_url( $url = '' ) { |
| 77 | 85 | if ( empty( $url ) ) { |
| 78 | 86 | $url = pll_get_requested_url(); |
| @@ -77,24 +85,32 @@ | ||
| 77 | 85 | if ( empty( $url ) ) { |
| 78 | 86 | $url = pll_get_requested_url(); |
| 79 | 87 | } |
| 80 | 88 | |
| 81 | - $pattern = '#lang=(' . implode( '|', $this->model->get_languages_list( array( 'fields' => 'slug' ) ) ) . ')#'; | |
| 82 | - return preg_match( $pattern, trailingslashit( $url ), $matches ) ? $matches[1] : ''; // $matches[1] is the slug of the requested language | |
| 89 | + $pattern = sprintf( | |
| 90 | + '#[?&]lang=(?<lang>%s)(?:$|&)#', | |
| 91 | + implode( '|', $this->model->get_languages_list( array( 'fields' => 'slug' ) ) ) | |
| 92 | + ); | |
| 93 | + return preg_match( $pattern, $url, $matches ) ? $matches['lang'] : ''; // $matches['lang'] is the slug of the requested language. | |
| 83 | 94 | } |
| 84 | 95 | |
| 85 | 96 | /** |
| 86 | - * Returns the static front page url | |
| 97 | + * Returns the static front page url in the given language. | |
| 87 | 98 | * |
| 88 | 99 | * @since 1.8 |
| 100 | + * @since 3.4 Accepts now an array of language properties. | |
| 89 | 101 | * |
| 90 | - * @param object $lang | |
| 91 | - * @return string | |
| 102 | + * @param PLL_Language|array $language Language object or array of language properties. | |
| 103 | + * @return string The static front page url. | |
| 92 | 104 | */ |
| 93 | - public function front_page_url( $lang ) { | |
| 94 | - if ( $this->options['hide_default'] && $lang->slug == $this->options['default_lang'] ) { | |
| 105 | + public function front_page_url( $language ) { | |
| 106 | + if ( $language instanceof PLL_Language ) { | |
| 107 | + $language = $language->to_array(); | |
| 108 | + } | |
| 109 | + | |
| 110 | + if ( $this->options['hide_default'] && $language['is_default'] ) { | |
| 95 | 111 | return trailingslashit( $this->home ); |
| 96 | 112 | } |
| 97 | - $url = home_url( '/?page_id=' . $lang->page_on_front ); | |
| 98 | - return $this->options['force_lang'] ? $this->add_language_to_link( $url, $lang ) : $url; | |
| 113 | + $url = home_url( '/?page_id=' . $language['page_on_front'] ); | |
| 114 | + return $this->options['force_lang'] ? $this->add_language_to_link( $url, $language['slug'] ) : $url; | |
| 99 | 115 | } |
| 100 | 116 | } |