You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

192 lines
4.7 KiB
PHP

<?php
/**
* The sitemap URL rewrite setup and handling functionality.
*
* @since 0.9.0
* @package RankMath
* @subpackage RankMath\Sitemap
* @author Rank Math <support@rankmath.com>
*
* @copyright Copyright (C) 2008-2019, Yoast BV
* The following code is a derivative work of the code from the Yoast(https://github.com/Yoast/wordpress-seo/), which is licensed under GPL v3.
*/
namespace RankMath\Sitemap;
use RankMath\Helper;
use RankMath\Traits\Hooker;
use RankMath\Helpers\Str;
use RankMath\Helpers\Url;
defined( 'ABSPATH' ) || exit;
/**
* Router class.
*/
class Router {
use Hooker;
/**
* The Constructor.
*/
public function __construct() {
$this->action( 'init', 'init', 1 );
$this->action( 'parse_query', 'request_sitemap', 1 );
$this->action( 'template_redirect', 'template_redirect', 0 );
$this->action( 'after_setup_theme', 'reduce_query_load', 99 );
}
/**
* Sets up rewrite rules.
*/
public function init() {
global $wp;
$base = self::get_sitemap_base();
$wp->add_query_var( 'sitemap' );
$wp->add_query_var( 'sitemap_n' );
$wp->add_query_var( 'xsl' );
add_rewrite_rule( $base . Sitemap::get_sitemap_index_slug() . '\\.xml$', 'index.php?sitemap=1', 'top' );
add_rewrite_rule( $base . '([^/]+?)-sitemap([0-9]+)?\.xml$', 'index.php?sitemap=$matches[1]&sitemap_n=$matches[2]', 'top' );
add_rewrite_rule( $base . '([a-z]+)?-?sitemap\.xsl$', 'index.php?xsl=$matches[1]', 'top' );
}
/**
* Serves sitemap when needed using correct sitemap module.
*
* @param WP_Query $query The WP_Query instance (passed by reference).
*/
public function request_sitemap( $query ) {
if ( ! $query->is_main_query() ) {
return;
}
$xsl = self::get_sitemap_slug( get_query_var( 'xsl' ) );
if ( ! empty( $xsl ) ) {
$this->filter( 'user_has_cap', 'filter_user_has_cap' );
$stylesheet = new Stylesheet();
$stylesheet->output( $xsl );
return;
}
$type = get_query_var( 'sitemap' );
if ( empty( $type ) ) {
return;
}
new Sitemap_XML( $type );
}
/**
* Check the current request URI, if we can determine it's probably an XML sitemap, kill loading the widgets.
*/
public function reduce_query_load() {
if ( ! isset( $_SERVER['REQUEST_URI'] ) ) {
return;
}
$request = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) );
$extension = substr( $request, -4 );
if ( Str::contains( 'sitemap', $request ) && in_array( $extension, [ '.xml', '.xsl' ], true ) ) {
remove_all_actions( 'widgets_init' );
}
}
/**
* Redirects `sitemap.xml` to `sitemap_index.xml`.
*/
public function template_redirect() {
if ( ! $this->needs_sitemap_index_redirect() ) {
return;
}
Helper::redirect( home_url( '/' . Sitemap::get_sitemap_index_slug() . '.xml' ), 301 );
exit;
}
/**
* Checks whether the current request needs to be redirected to sitemap_index.xml.
*
* @return bool True if redirect is needed, false otherwise.
*/
public function needs_sitemap_index_redirect() {
global $wp_query;
return $wp_query->is_404 && home_url( '/sitemap.xml' ) === Url::get_current_url();
}
/**
* Create base URL for the sitemap.
*
* @param string $page Page to append to the base URL.
*
* @return string base URL (incl page)
*/
public static function get_base_url( $page ) {
$page = self::get_page_url( $page );
$base = self::get_sitemap_base();
return home_url( $base . $page );
}
/**
* Create base URL for the sitemap.
*
* @since 1.0.43
*
* @return string Sitemap base.
*/
public static function get_sitemap_base() {
global $wp_rewrite;
$base = $wp_rewrite->using_index_permalinks() ? $wp_rewrite->index . '/' : '';
/**
* Filter the base URL of the sitemaps.
*
* @param string $base The string that should be added to home_url() to make the full base URL.
*/
return apply_filters( 'rank_math/sitemap/base_url', $base );
}
/**
* Get sitemap slug.
*
* @param string $type Sitemap type.
* @return string
*/
public static function get_sitemap_slug( $type ) {
/**
* Filter the slug of the sitemap.
*
* @param string $slug Slug of the sitemap.
*/
return apply_filters( "rank_math/sitemap/{$type}/slug", $type );
}
/**
* Get page URL for the sitemap.
*
* @param string $page Page to append to the base URL.
*
* @return string
*/
public static function get_page_url( $page ) {
global $wp_rewrite;
if ( $wp_rewrite->using_permalinks() ) {
return $page;
}
if ( Sitemap::get_sitemap_index_slug() . '.xml' === $page ) {
return '?sitemap=1';
}
$page = \preg_replace( '/([^\/]+?)-sitemap([0-9]+)?\.xml$/', '?sitemap=$1&sitemap_n=$2', $page );
$page = \preg_replace( '/([a-z]+)?-?sitemap\.xsl$/', '?xsl=$1', $page );
$page = str_replace( 'locations.kml', '?sitemap=locations', $page );
return $page;
}
}