wordpress/php-fpm/wordpress_files/plugins/polylang/frontend/frontend-static-pages.php
2020-05-22 01:40:23 +00:00

268 lines
8.9 KiB
PHP

<?php
/**
* Manages the static front page and the page for posts on frontend
*
* @since 1.8
*/
class PLL_Frontend_Static_Pages extends PLL_Static_Pages {
/**
* Constructor: setups filters and actions
*
* @since 1.8
*
* @param object $polylang
*/
public function __construct( &$polylang ) {
parent::__construct( $polylang );
$this->links_model = &$polylang->links_model;
$this->links = &$polylang->links;
add_action( 'pll_language_defined', array( $this, 'pll_language_defined' ) );
add_action( 'pll_home_requested', array( $this, 'pll_home_requested' ) );
// Manages the redirection of the homepage
add_filter( 'redirect_canonical', array( $this, 'redirect_canonical' ), 10, 2 );
add_filter( 'pll_pre_translation_url', array( $this, 'pll_pre_translation_url' ), 10, 3 );
add_filter( 'pll_check_canonical_url', array( $this, 'pll_check_canonical_url' ) );
add_filter( 'pll_set_language_from_query', array( $this, 'page_on_front_query' ), 10, 2 );
add_filter( 'pll_set_language_from_query', array( $this, 'page_for_posts_query' ), 10, 2 );
}
/**
* Init the filters
*
* @since 1.8
*/
public function pll_language_defined() {
// Translates our page on front and page for posts properties
$this->init();
// Translates page for posts and page on front
add_filter( 'option_page_on_front', array( $this, 'translate_page_on_front' ) );
add_filter( 'option_page_for_posts', array( $this, 'translate_page_for_posts' ) );
// Support theme customizer
if ( isset( $_POST['wp_customize'], $_POST['customized'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
add_filter( 'pre_option_page_on_front', 'pll_get_post', 20 );
add_filter( 'pre_option_page_for_post', 'pll_get_post', 20 );
}
}
/**
* Translates the page_id query var when the site root page is requested
*
* @since 1.8
*/
public function pll_home_requested() {
set_query_var( 'page_id', $this->curlang->page_on_front );
}
/**
* Translates page on front
*
* @since 1.8
*
* @param int $v page on front page id
* @return int
*/
public function translate_page_on_front( $v ) {
// Don't attempt to translate in a 'switch_blog' action as there is a risk to call this function while initializing the languages cache
return isset( $this->curlang->page_on_front ) && ! doing_action( 'switch_blog' ) ? $this->curlang->page_on_front : $v;
}
/**
* Manages canonical redirection of the homepage when using page on front
*
* @since 0.1
*
* @param string $redirect_url
* @param string $requested_url
* @return bool|string modified url, false if redirection is canceled
*/
public function redirect_canonical( $redirect_url, $requested_url ) {
global $wp_query;
if ( is_page() && ! is_feed() && isset( $wp_query->queried_object ) && $wp_query->queried_object->ID == $this->curlang->page_on_front ) {
$url = is_paged() ? $this->links_model->add_paged_to_link( $this->links->get_home_url(), $wp_query->query_vars['page'] ) : $this->links->get_home_url();
// Don't forget additional query vars
$query = wp_parse_url( $redirect_url, PHP_URL_QUERY );
if ( ! empty( $query ) ) {
parse_str( $query, $query_vars );
$query_vars = rawurlencode_deep( $query_vars ); // WP encodes query vars values
$url = add_query_arg( $query_vars, $url );
}
return $url;
}
return $redirect_url;
}
/**
* Translates the url of the page on front and page for posts
*
* @since 1.8
*
* @param string $url not used
* @param object $language language in which we want the translation
* @param int $queried_object_id id of the queried object
* @return string
*/
public function pll_pre_translation_url( $url, $language, $queried_object_id ) {
if ( ! empty( $queried_object_id ) ) {
// Page for posts
if ( $GLOBALS['wp_query']->is_posts_page && ( $id = $this->model->post->get( $queried_object_id, $language ) ) ) {
$url = get_permalink( $id );
}
// Page on front
elseif ( is_front_page() && $language->page_on_front && ( $language->page_on_front == $this->model->post->get( $queried_object_id, $language ) ) ) {
$url = $language->home_url;
}
}
return $url;
}
/**
* Prevents canonical redirection if we are on a static front page
*
* @since 1.8
*
* @param string $redirect_url
* @return bool|string
*/
public function pll_check_canonical_url( $redirect_url ) {
return $this->options['redirect_lang'] && ! $this->options['force_lang'] && ! empty( $this->curlang->page_on_front ) && is_page( $this->curlang->page_on_front ) ? false : $redirect_url;
}
/**
* Is the query for a the static front page (redirected from the language page)?
*
* @since 2.3
*
* @param object $query
* @return bool
*/
protected function is_front_page( $query ) {
$query = array_diff( array_keys( $query->query ), array( 'preview', 'page', 'paged', 'cpage', 'orderby' ) );
return 1 === count( $query ) && in_array( 'lang', $query );
}
/**
* Setups query vars when requesting a static front page
*
* @since 1.8
*
* @param bool|object $lang
* @param object $query
* @return bool|object
*/
public function page_on_front_query( $lang, $query ) {
if ( ! empty( $lang ) || ! $this->page_on_front ) {
return $lang;
}
// The home page is requested
if ( did_action( 'home_requested' ) ) {
$query->set( 'page_id', $lang->page_on_front );
}
// Redirect the language page to the homepage when using a static front page
elseif ( ( $this->options['redirect_lang'] || $this->options['hide_default'] ) && $this->is_front_page( $query ) && $lang = $this->model->get_language( get_query_var( 'lang' ) ) ) {
$query->is_archive = $query->is_tax = false;
if ( ! empty( $lang->page_on_front ) ) {
$query->set( 'page_id', $lang->page_on_front );
$query->is_singular = $query->is_page = true;
unset( $query->query_vars['lang'], $query->queried_object ); // Reset queried object
} else {
// Handle case where the static front page hasn't be translated to avoid a possible infinite redirect loop.
$query->is_home = true;
}
}
// Fix paged static front page in plain permalinks when Settings > Reading doesn't match the default language
elseif ( ! $this->links_model->using_permalinks && count( $query->query ) === 1 && ! empty( $query->query['page'] ) ) {
$lang = $this->model->get_language( $this->options['default_lang'] );
$query->set( 'page_id', $lang->page_on_front );
$query->is_singular = $query->is_page = true;
$query->is_archive = $query->is_tax = false;
unset( $query->query_vars['lang'], $query->queried_object ); // Reset queried object
}
// Set the language when requesting a static front page
else {
$page_id = $this->get_page_id( $query );
$languages = $this->model->get_languages_list();
$pages = wp_list_pluck( $languages, 'page_on_front' );
if ( ! empty( $page_id ) && false !== $n = array_search( $page_id, $pages ) ) {
$lang = $languages[ $n ];
}
}
// Fix <!--nextpage--> for page_on_front
if ( ( $this->options['force_lang'] < 2 || ! $this->options['redirect_lang'] ) && $this->links_model->using_permalinks && ! empty( $lang ) && isset( $query->query['paged'] ) ) {
$query->set( 'page', $query->query['paged'] );
unset( $query->query['paged'] );
} elseif ( ! $this->links_model->using_permalinks && ! empty( $query->query['page'] ) ) {
$query->is_paged = true;
}
return $lang;
}
/**
* Setups query vars when requesting a posts page
*
* @since 1.8
*
* @param bool|object $lang
* @param object $query
* @return bool|object
*/
public function page_for_posts_query( $lang, $query ) {
if ( empty( $lang ) && $this->page_for_posts ) {
$page_id = $this->get_page_id( $query );
if ( ! empty( $page_id ) && in_array( $page_id, $pages = $this->model->get_languages_list( array( 'fields' => 'page_for_posts' ) ) ) ) {
// Fill the cache with all pages for posts to avoid one query per page later
// The posts_per_page limit is a trick to avoid splitting the query
get_posts( array( 'posts_per_page' => 999, 'post_type' => 'page', 'post__in' => $pages, 'lang' => '' ) );
$lang = $this->model->post->get_language( $page_id );
$query->is_singular = $query->is_page = false;
$query->is_home = $query->is_posts_page = true;
}
}
return $lang;
}
/**
* Get queried page_id ( if exists )
* If permalinks are used, WordPress does set and use $query->queried_object_id and sets $query->query_vars['page_id'] to 0
* and does set and use $query->query_vars['page_id'] if permalinks are not used :(
*
* @since 1.5
*
* @param object $query instance of WP_Query
* @return int page_id
*/
protected function get_page_id( $query ) {
if ( ! empty( $query->query_vars['pagename'] ) && isset( $query->queried_object_id ) ) {
return $query->queried_object_id;
}
if ( isset( $query->query_vars['page_id'] ) ) {
return $query->query_vars['page_id'];
}
return 0; // No page queried
}
}