Changeset 36495 for trunk/src/wp-includes/class-wp-site.php

Timestamp:

02/07/2016 02:12:44 AM (11 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:

• trunk/src/wp-includes/class-wp-site.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-site.php

@@ -149 +149 @@
 
         /**
-         * Retrieve a site from the database by its ID.
-         *
+         * Retrieves a site from the database by its ID.
+         *
+         * @static
          * @since 4.5.0
          * @access public
@@ -157 +158 @@
          *
          * @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 ) {
@@ -183 +184 @@
 
         /**
-         * Create a new WP_Site object.
+         * Creates a new WP_Site object.
          *
          * Will populate object properties from the object provided and assign other