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.

Built from https://develop.svn.wordpress.org/trunk@36495


git-svn-id: http://core.svn.wordpress.org/trunk@36462 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-02-07 02:13:26 +00:00
parent 3e7db642a6
commit e2cec35437
2 changed files with 5 additions and 4 deletions

View File

@ -148,15 +148,16 @@ final class WP_Site {
public $lang_id = '0'; public $lang_id = '0';
/** /**
* Retrieve a site from the database by its ID. * Retrieves a site from the database by its ID.
* *
* @static
* @since 4.5.0 * @since 4.5.0
* @access public * @access public
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int $site_id The ID of the site to retrieve. * @param int $site_id The ID of the site to retrieve.
* @return WP_Site|bool The site's object if found. False if not. * @return WP_Site|false The site's object if found. False if not.
*/ */
public static function get_instance( $site_id ) { public static function get_instance( $site_id ) {
global $wpdb; global $wpdb;
@ -182,7 +183,7 @@ final class WP_Site {
} }
/** /**
* Create a new WP_Site object. * Creates a new WP_Site object.
* *
* Will populate object properties from the object provided and assign other * Will populate object properties from the object provided and assign other
* default properties based on that information. * default properties based on that information.

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-36494'; $wp_version = '4.5-alpha-36495';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.