WordPress.org

Make WordPress Core

Changeset 36495


Ignore:
Timestamp:
02/07/2016 02:12:44 AM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Make some minor improvements to inline docs for WP_Site, introduced in [36393].

  • Uses third-person singular verbs in method summaries
  • Adds an @static tag to the WP_Site::get_instance() DocBlock
  • Adjusts return types for WP_Site::get_instance() to the more explicit WP_Site|false

See #32450. See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-site.php

    r36393 r36495  
    149149
    150150    /**
    151      * Retrieve a site from the database by its ID.
    152      *
     151     * Retrieves a site from the database by its ID.
     152     *
     153     * @static
    153154     * @since 4.5.0
    154155     * @access public
     
    157158     *
    158159     * @param int $site_id The ID of the site to retrieve.
    159      * @return WP_Site|bool The site's object if found. False if not.
     160     * @return WP_Site|false The site's object if found. False if not.
    160161     */
    161162    public static function get_instance( $site_id ) {
     
    183184
    184185    /**
    185      * Create a new WP_Site object.
     186     * Creates a new WP_Site object.
    186187     *
    187188     * Will populate object properties from the object provided and assign other
Note: See TracChangeset for help on using the changeset viewer.