| @@ -10,19 +10,24 @@ | ||
| 10 | 10 | * |
| 11 | 11 | * @since 1.2 |
| 12 | 12 | */ |
| 13 | 13 | class PLL_Links_Default extends PLL_Links_Model { |
| 14 | + /** | |
| 15 | + * Tells this child class of PLL_Links_Model does not use pretty permalinks. | |
| 16 | + * | |
| 17 | + * @var bool | |
| 18 | + */ | |
| 14 | 19 | public $using_permalinks = false; |
| 15 | 20 | |
| 16 | 21 | /** |
| 17 | - * Adds language information to an url | |
| 18 | - * links_model interface | |
| 22 | + * Adds the language code in a url. | |
| 23 | + * links_model interface. | |
| 19 | 24 | * |
| 20 | 25 | * @since 1.2 |
| 21 | 26 | * |
| 22 | - * @param string $url url to modify | |
| 23 | - * @param object $lang language | |
| 24 | - * @return string modified url | |
| 27 | + * @param string $url The url to modify. | |
| 28 | + * @param PLL_Language $lang The language object. | |
| 29 | + * @return string Modified url. | |
| 25 | 30 | */ |
| 26 | 31 | public function add_language_to_link( $url, $lang ) { |
| 27 | 32 | return empty( $lang ) || ( $this->options['hide_default'] && $this->options['default_lang'] == $lang->slug ) ? $url : add_query_arg( 'lang', $lang->slug, $url ); |
| 28 | 33 | } |
| @@ -85,14 +90,14 @@ | ||
| 85 | 90 | return preg_match( $pattern, trailingslashit( $url ), $matches ) ? $matches[1] : ''; // $matches[1] is the slug of the requested language |
| 86 | 91 | } |
| 87 | 92 | |
| 88 | 93 | /** |
| 89 | - * Returns the static front page url | |
| 94 | + * Returns the static front page url. | |
| 90 | 95 | * |
| 91 | 96 | * @since 1.8 |
| 92 | 97 | * |
| 93 | - * @param object $lang | |
| 94 | - * @return string | |
| 98 | + * @param PLL_Language $lang The language object. | |
| 99 | + * @return string The static front page url. | |
| 95 | 100 | */ |
| 96 | 101 | public function front_page_url( $lang ) { |
| 97 | 102 | if ( $this->options['hide_default'] && $lang->slug == $this->options['default_lang'] ) { |
| 98 | 103 | return trailingslashit( $this->home ); |