WordPress.org
Get WordPress

Make WordPress Core

Changeset 48093


Ignore:
Timestamp:
06/19/2020 05:54:56 PM (6 years ago)
Author:
SergeyBiryukov
Message:

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

See #49572, #50117.

Location:
trunk/src/wp-includes
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/sitemaps.php

    r48072 r48093  
    1616 * @since 5.5.0
    1717 *
     18 * @global WP_Sitemaps $wp_sitemaps Global Core Sitemaps instance.
     19 *
    1820 * @return WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled.
    1921 */
    2022function wp_sitemaps_get_server() {
    21     /**
    22      * Global Core Sitemaps instance.
    23      *
    24      * @since 5.5.0
    25      *
    26      * @var WP_Sitemaps $wp_sitemaps
    27      */
    2823    global $wp_sitemaps;
    2924

  • trunk/src/wp-includes/sitemaps/class-wp-sitemaps-index.php

    r48072 r48093  
    6868     * @since 5.5.0
    6969     *
     70     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
     71     *
    7072     * @return string The sitemap index url.
    7173     */
    7274    public function get_index_url() {
    73         /* @var WP_Rewrite $wp_rewrite */
    7475        global $wp_rewrite;
    7576

  • trunk/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php

    r48080 r48093  
    137137     * @since 5.5.0
    138138     *
     139     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
     140     *
    139141     * @param string $name The name of the sitemap.
    140142     * @param int    $page The page of the sitemap.
    … …  
    142144     */
    143145    public function get_sitemap_url( $name, $page ) {
    144         /* @var WP_Rewrite $wp_rewrite */
    145146        global $wp_rewrite;
    146147

  • trunk/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php

    r48081 r48093  
    5858     * @since 5.5.0
    5959     *
     60     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
     61     *
    6062     * @return string The sitemap stylesheet url.
    6163     */
    6264    public function get_sitemap_stylesheet_url() {
    63         /* @var WP_Rewrite $wp_rewrite */
    6465        global $wp_rewrite;
    6566
    … …  
    8889     * @since 5.5.0
    8990     *
     91     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
     92     *
    9093     * @return string The sitemap index stylesheet url.
    9194     */
    9295    public function get_sitemap_index_stylesheet_url() {
    93         /* @var WP_Rewrite $wp_rewrite */
    9496        global $wp_rewrite;
    9597

  • trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php

    r48081 r48093  
    140140     *
    141141     * @since 5.5.0
     142     *
     143     * @global WP_Query $wp_query WordPress Query object.
    142144     */
    143145    public function render_sitemaps() {
Note: See TracChangeset for help on using the changeset viewer.