2021-09-21 15:01:08 +02:00
< ? php
2021-09-21 15:06:29 +02:00
/**
* @ package Polylang
*/
2021-09-21 15:01:08 +02:00
/**
2021-09-21 15:06:29 +02:00
* Base class to choose the language
2021-09-21 15:01:08 +02:00
*
* @ since 1.2
*/
abstract class PLL_Choose_Lang {
2021-09-21 15:06:29 +02:00
/**
* Stores the plugin options .
*
* @ var array
*/
public $options ;
/**
* @ var PLL_Model
*/
public $model ;
/**
* Instance of a child class of PLL_Links_Model .
*
* @ var PLL_Links_Model
*/
public $links_model ;
/**
* Current language .
*
* @ var PLL_Language
*/
2021-09-21 15:01:08 +02:00
public $curlang ;
2021-09-21 15:06:29 +02:00
/**
* @ var PLL_Accept_Language
*/
private $lang_parse ;
/**
* @ var PLL_Accept_Languages_Collection
*/
private $accept_langs ;
2021-09-21 15:01:08 +02:00
/**
2021-09-21 15:06:29 +02:00
* Constructor
2021-09-21 15:01:08 +02:00
*
* @ since 1.2
*
* @ param object $polylang
*/
public function __construct ( & $polylang ) {
$this -> links_model = & $polylang -> links_model ;
$this -> model = & $polylang -> model ;
$this -> options = & $polylang -> options ;
$this -> curlang = & $polylang -> curlang ;
}
/**
2021-09-21 15:06:29 +02:00
* Sets the language for ajax requests
2021-09-21 15:01:08 +02:00
* and setup actions
2021-09-21 15:06:29 +02:00
* Any child class must call this method if it overrides it
2021-09-21 15:01:08 +02:00
*
* @ since 1.8
2021-09-21 15:06:29 +02:00
*
* @ return void
2021-09-21 15:01:08 +02:00
*/
public function init () {
2021-09-21 15:06:29 +02:00
if ( Polylang :: is_ajax_on_front () || ! wp_using_themes () ) {
$this -> set_language ( empty ( $_REQUEST [ 'lang' ] ) ? $this -> get_preferred_language () : $this -> model -> get_language ( sanitize_key ( $_REQUEST [ 'lang' ] ) ) ); // phpcs:ignore WordPress.Security.NonceVerification
2021-09-21 15:01:08 +02:00
}
add_action ( 'pre_comment_on_post' , array ( $this , 'pre_comment_on_post' ) ); // sets the language of comment
add_action ( 'parse_query' , array ( $this , 'parse_main_query' ), 2 ); // sets the language in special cases
add_action ( 'wp' , array ( $this , 'maybe_setcookie' ), 7 );
}
/**
2021-09-21 15:06:29 +02:00
* Sets the current language
* and fires the action 'pll_language_defined' .
2021-09-21 15:01:08 +02:00
*
* @ since 1.2
*
2021-09-21 15:06:29 +02:00
* @ param PLL_Language $curlang Current language .
* @ return void
2021-09-21 15:01:08 +02:00
*/
protected function set_language ( $curlang ) {
2021-09-21 15:06:29 +02:00
// Don't set the language a second time
2021-09-21 15:01:08 +02:00
if ( isset ( $this -> curlang ) ) {
return ;
}
2021-09-21 15:06:29 +02:00
// Final check in case $curlang has an unexpected value
// See https://wordpress.org/support/topic/detect-browser-language-sometimes-setting-null-language
2021-09-21 15:01:08 +02:00
$this -> curlang = ( $curlang instanceof PLL_Language ) ? $curlang : $this -> model -> get_language ( $this -> options [ 'default_lang' ] );
$GLOBALS [ 'text_direction' ] = $this -> curlang -> is_rtl ? 'rtl' : 'ltr' ;
2021-09-21 15:06:29 +02:00
if ( did_action ( 'wp_default_styles' ) ) {
wp_styles () -> text_direction = $GLOBALS [ 'text_direction' ];
}
2021-09-21 15:01:08 +02:00
/**
2021-09-21 15:06:29 +02:00
* Fires when the current language is defined .
2021-09-21 15:01:08 +02:00
*
* @ since 0.9 . 5
*
2021-09-21 15:06:29 +02:00
* @ param string $slug Current language code .
* @ param PLL_Language $curlang Current language object .
2021-09-21 15:01:08 +02:00
*/
do_action ( 'pll_language_defined' , $this -> curlang -> slug , $this -> curlang );
}
/**
2021-09-21 15:06:29 +02:00
* Set a cookie to remember the language .
* Setting PLL_COOKIE to false will disable cookie although it will break some functionalities
2021-09-21 15:01:08 +02:00
*
* @ since 1.5
2021-09-21 15:06:29 +02:00
*
* @ return void
2021-09-21 15:01:08 +02:00
*/
public function maybe_setcookie () {
2021-09-21 15:06:29 +02:00
// Don't set cookie in javascript when a cache plugin is active.
if ( ! pll_is_cache_active () && ! empty ( $this -> curlang ) && ! is_404 () ) {
$args = array (
'domain' => 2 === $this -> options [ 'force_lang' ] ? wp_parse_url ( $this -> links_model -> home , PHP_URL_HOST ) : COOKIE_DOMAIN ,
'samesite' => 3 === $this -> options [ 'force_lang' ] ? 'None' : 'Lax' ,
2021-09-21 15:01:08 +02:00
);
2021-09-21 15:06:29 +02:00
PLL_Cookie :: set ( $this -> curlang -> slug , $args );
2021-09-21 15:01:08 +02:00
}
}
/**
2021-09-21 15:06:29 +02:00
* Get the preferred language according to the browser preferences .
2021-09-21 15:01:08 +02:00
*
* @ since 1.8
*
2021-09-21 15:06:29 +02:00
* @ return string | bool The preferred language slug or false .
2021-09-21 15:01:08 +02:00
*/
public function get_preferred_browser_language () {
if ( isset ( $_SERVER [ 'HTTP_ACCEPT_LANGUAGE' ] ) ) {
2021-09-21 15:06:29 +02:00
$accept_langs = PLL_Accept_Languages_Collection :: from_accept_language_header ( sanitize_text_field ( wp_unslash ( $_SERVER [ 'HTTP_ACCEPT_LANGUAGE' ] ) ) );
2021-09-21 15:01:08 +02:00
2021-09-21 15:06:29 +02:00
$accept_langs -> bubble_sort ();
2021-09-21 15:01:08 +02:00
2021-09-21 15:06:29 +02:00
$languages = $this -> model -> get_languages_list ( array ( 'hide_empty' => true ) ); // Hides languages with no post.
2021-09-21 15:01:08 +02:00
2021-09-21 15:06:29 +02:00
/**
* Filters the list of languages to use to match the browser preferences .
*
* @ since 1.9 . 3
*
* @ param array $languages Array of PLL_Language objects .
*/
$languages = apply_filters ( 'pll_languages_for_browser_preferences' , $languages );
return $accept_langs -> find_best_match ( $languages );
2021-09-21 15:01:08 +02:00
}
2021-09-21 15:06:29 +02:00
2021-09-21 15:01:08 +02:00
return false ;
}
/**
2021-09-21 15:06:29 +02:00
* Returns the preferred language
* either from the cookie if it ' s a returning visit
* or according to browser preference
* or the default language
2021-09-21 15:01:08 +02:00
*
* @ since 0.1
*
* @ return object browser preferred language or default language
*/
public function get_preferred_language () {
2021-09-21 15:06:29 +02:00
$language = false ;
$cookie = false ;
2021-09-21 15:01:08 +02:00
if ( isset ( $_COOKIE [ PLL_COOKIE ] ) ) {
2021-09-21 15:06:29 +02:00
// Check first if the user was already browsing this site.
$language = sanitize_key ( $_COOKIE [ PLL_COOKIE ] );
$cookie = true ;
} elseif ( $this -> options [ 'browser' ] ) {
$language = $this -> get_preferred_browser_language ();
2021-09-21 15:01:08 +02:00
}
/**
* Filter the visitor ' s preferred language ( normally set first by cookie
* if this is not the first visit , then by the browser preferences ) .
* If no preferred language has been found or set by this filter ,
* Polylang fallbacks to the default language
*
* @ since 1.0
2021-09-21 15:06:29 +02:00
* @ since 2.7 Added $cookie parameter .
2021-09-21 15:01:08 +02:00
*
2021-09-21 15:06:29 +02:00
* @ param string | bool $language Preferred language code , false if none has been found .
* @ param bool $cookie Whether the preferred language has been defined by the cookie .
2021-09-21 15:01:08 +02:00
*/
2021-09-21 15:06:29 +02:00
$slug = apply_filters ( 'pll_preferred_language' , $language , $cookie );
2021-09-21 15:01:08 +02:00
2021-09-21 15:06:29 +02:00
// Return default if there is no preferences in the browser or preferences does not match our languages or it is requested not to use the browser preference
2021-09-21 15:01:08 +02:00
return ( $lang = $this -> model -> get_language ( $slug ) ) ? $lang : $this -> model -> get_language ( $this -> options [ 'default_lang' ] );
}
/**
2021-09-21 15:06:29 +02:00
* Sets the language when home page is requested
2021-09-21 15:01:08 +02:00
*
* @ since 1.2
2021-09-21 15:06:29 +02:00
*
* @ return void
2021-09-21 15:01:08 +02:00
*/
protected function home_language () {
2021-09-21 15:06:29 +02:00
// Test referer in case PLL_COOKIE is set to false. Since WP 3.6.1, wp_get_referer() validates the host which is exactly what we want
// Thanks to Ov3rfly http://wordpress.org/support/topic/enhance-feature-when-front-page-is-visited-set-language-according-to-browser
$language = $this -> options [ 'hide_default' ] && ( wp_get_referer () || ! $this -> options [ 'browser' ] ) ?
2021-09-21 15:01:08 +02:00
$this -> model -> get_language ( $this -> options [ 'default_lang' ] ) :
2021-09-21 15:06:29 +02:00
$this -> get_preferred_language (); // Sets the language according to browser preference or default language
2021-09-21 15:01:08 +02:00
$this -> set_language ( $language );
}
/**
2021-09-21 15:06:29 +02:00
* To call when the home page has been requested
* Make sure to call this after 'setup_theme' has been fired as we need $wp_query
* Performs a redirection to the home page in the current language if needed
2021-09-21 15:01:08 +02:00
*
* @ since 0.9
2021-09-21 15:06:29 +02:00
*
* @ return void
2021-09-21 15:01:08 +02:00
*/
public function home_requested () {
2021-09-21 15:06:29 +02:00
// We are already on the right page
2021-09-21 15:01:08 +02:00
if ( $this -> options [ 'default_lang' ] == $this -> curlang -> slug && $this -> options [ 'hide_default' ] ) {
$this -> set_curlang_in_query ( $GLOBALS [ 'wp_query' ] );
/**
* Fires when the site root page is requested
*
* @ since 1.8
*/
do_action ( 'pll_home_requested' );
}
2021-09-21 15:06:29 +02:00
// Redirect to the home page in the right language
// Test to avoid crash if get_home_url returns something wrong
2021-09-21 15:01:08 +02:00
// FIXME why this happens? http://wordpress.org/support/topic/polylang-crashes-1
2021-09-21 15:06:29 +02:00
// Don't redirect if $_POST is not empty as it could break other plugins
elseif ( is_string ( $redirect = $this -> curlang -> home_url ) && empty ( $_POST ) ) { // phpcs:ignore WordPress.Security.NonceVerification
// Don't forget the query string which may be added by plugins
$query_string = wp_parse_url ( pll_get_requested_url (), PHP_URL_QUERY );
if ( ! empty ( $query_string ) ) {
$redirect .= ( $this -> links_model -> using_permalinks ? '?' : '&' ) . $query_string ;
}
2021-09-21 15:01:08 +02:00
/**
* When a visitor reaches the site home , Polylang redirects to the home page in the correct language .
* This filter allows plugins to modify the redirected url or prevent this redirection
2021-09-21 15:06:29 +02:00
* /! \ this filter may be fired * before * the theme is loaded
2021-09-21 15:01:08 +02:00
*
* @ since 1.1 . 1
*
* @ param string $redirect the url the visitor will be redirected to
*/
2021-09-21 15:06:29 +02:00
$redirect = apply_filters ( 'pll_redirect_home' , $redirect );
if ( $redirect && wp_validate_redirect ( $redirect ) ) {
$this -> maybe_setcookie ();
header ( 'Vary: Accept-Language' );
wp_safe_redirect ( $redirect , 302 , POLYLANG );
2021-09-21 15:01:08 +02:00
exit ;
}
}
}
/**
2021-09-21 15:06:29 +02:00
* Set the language when posting a comment
2021-09-21 15:01:08 +02:00
*
* @ since 0.8 . 4
*
* @ param int $post_id the post being commented
2021-09-21 15:06:29 +02:00
* @ return void
2021-09-21 15:01:08 +02:00
*/
public function pre_comment_on_post ( $post_id ) {
$this -> set_language ( $this -> model -> post -> get_language ( $post_id ) );
}
/**
2021-09-21 15:06:29 +02:00
* Modifies some main query vars for the home page and the page for posts
* to enable one home page ( and one page for posts ) per language .
2021-09-21 15:01:08 +02:00
*
* @ since 1.2
*
2021-09-21 15:06:29 +02:00
* @ param WP_Query $query Instance of WP_Query .
* @ return void
2021-09-21 15:01:08 +02:00
*/
public function parse_main_query ( $query ) {
if ( ! $query -> is_main_query () ) {
return ;
}
/**
* This filter allows to set the language based on information contained in the main query
*
* @ since 1.8
*
2021-09-21 15:06:29 +02:00
* @ param PLL_Language | false $lang Language object or false .
* @ param WP_Query $query WP_Query object .
2021-09-21 15:01:08 +02:00
*/
if ( $lang = apply_filters ( 'pll_set_language_from_query' , false , $query ) ) {
$this -> set_language ( $lang );
$this -> set_curlang_in_query ( $query );
}
// sets is_home on translated home page when it displays posts
// is_home must be true on page 2, 3... too
// as well as when searching an empty string: http://wordpress.org/support/topic/plugin-polylang-polylang-breaks-search-in-spun-theme
elseif ( ( count ( $query -> query ) == 1 || ( is_paged () && count ( $query -> query ) == 2 ) || ( isset ( $query -> query [ 's' ] ) && ! $query -> query [ 's' ] ) ) && $lang = get_query_var ( 'lang' ) ) {
$lang = $this -> model -> get_language ( $lang );
$this -> set_language ( $lang ); // sets the language now otherwise it will be too late to filter sticky posts !
$query -> is_home = true ;
$query -> is_archive = $query -> is_tax = false ;
}
}
/**
2021-09-21 15:06:29 +02:00
* Sets the current language in the query .
2021-09-21 15:01:08 +02:00
*
* @ since 2.2
*
2021-09-21 15:06:29 +02:00
* @ param WP_Query $query Instance of WP_Query .
* @ return void
2021-09-21 15:01:08 +02:00
*/
protected function set_curlang_in_query ( & $query ) {
$pll_query = new PLL_Query ( $query , $this -> model );
$pll_query -> set_language ( $this -> curlang );
}
}