Docs: Document globals in `WP_Sitemaps_*` classes the same way they are documented in the rest of core.

See #49572, #50117.

git-svn-id: https://develop.svn.wordpress.org/trunk@48093 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-06-19 17:54:56 +00:00
parent 52ce85d0a5
commit 7bf879af49
5 changed files with 12 additions and 11 deletions

View File

@ -15,16 +15,11 @@
* *
* @since 5.5.0 * @since 5.5.0
* *
* @global WP_Sitemaps $wp_sitemaps Global Core Sitemaps instance.
*
* @return WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled. * @return WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled.
*/ */
function wp_sitemaps_get_server() { function wp_sitemaps_get_server() {
/**
* Global Core Sitemaps instance.
*
* @since 5.5.0
*
* @var WP_Sitemaps $wp_sitemaps
*/
global $wp_sitemaps; global $wp_sitemaps;
$is_enabled = (bool) get_option( 'blog_public' ); $is_enabled = (bool) get_option( 'blog_public' );

View File

@ -67,10 +67,11 @@ class WP_Sitemaps_Index {
* *
* @since 5.5.0 * @since 5.5.0
* *
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @return string The sitemap index url. * @return string The sitemap index url.
*/ */
public function get_index_url() { public function get_index_url() {
/* @var WP_Rewrite $wp_rewrite */
global $wp_rewrite; global $wp_rewrite;
if ( ! $wp_rewrite->using_permalinks() ) { if ( ! $wp_rewrite->using_permalinks() ) {

View File

@ -136,12 +136,13 @@ abstract class WP_Sitemaps_Provider {
* *
* @since 5.5.0 * @since 5.5.0
* *
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @param string $name The name of the sitemap. * @param string $name The name of the sitemap.
* @param int $page The page of the sitemap. * @param int $page The page of the sitemap.
* @return string The composed URL for a sitemap entry. * @return string The composed URL for a sitemap entry.
*/ */
public function get_sitemap_url( $name, $page ) { public function get_sitemap_url( $name, $page ) {
/* @var WP_Rewrite $wp_rewrite */
global $wp_rewrite; global $wp_rewrite;
if ( ! $wp_rewrite->using_permalinks() ) { if ( ! $wp_rewrite->using_permalinks() ) {

View File

@ -57,10 +57,11 @@ class WP_Sitemaps_Renderer {
* *
* @since 5.5.0 * @since 5.5.0
* *
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @return string The sitemap stylesheet url. * @return string The sitemap stylesheet url.
*/ */
public function get_sitemap_stylesheet_url() { public function get_sitemap_stylesheet_url() {
/* @var WP_Rewrite $wp_rewrite */
global $wp_rewrite; global $wp_rewrite;
$sitemap_url = home_url( '/wp-sitemap.xsl' ); $sitemap_url = home_url( '/wp-sitemap.xsl' );
@ -87,10 +88,11 @@ class WP_Sitemaps_Renderer {
* *
* @since 5.5.0 * @since 5.5.0
* *
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @return string The sitemap index stylesheet url. * @return string The sitemap index stylesheet url.
*/ */
public function get_sitemap_index_stylesheet_url() { public function get_sitemap_index_stylesheet_url() {
/* @var WP_Rewrite $wp_rewrite */
global $wp_rewrite; global $wp_rewrite;
$sitemap_url = home_url( '/wp-sitemap-index.xsl' ); $sitemap_url = home_url( '/wp-sitemap-index.xsl' );

View File

@ -139,6 +139,8 @@ class WP_Sitemaps {
* Renders sitemap templates based on rewrite rules. * Renders sitemap templates based on rewrite rules.
* *
* @since 5.5.0 * @since 5.5.0
*
* @global WP_Query $wp_query WordPress Query object.
*/ */
public function render_sitemaps() { public function render_sitemaps() {
global $wp_query; global $wp_query;