Changeset 46985 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php

Timestamp:

12/18/2019 12:17:54 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Various documentation fixes for unit test factories.

See #48303.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php (modified) (3 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php

@@ -25 +25 @@
 
     /**
-     * Creates a blog object.
+     * Creates a site object.
      *
      * @param array $args Arguments for the site object.
      *
-     * @return int|WP_Error Returns WP_Error object on failure, the site ID on success.
+     * @return int|WP_Error The site ID on success, WP_Error object on failure.
      */
     public function create_object( $args ) {
@@ -47 +47 @@
 
     /**
-     * Updates a blog object. Not implemented.
+     * Updates a site object. Not implemented.
      *
-     * @param int   $blog_id The blog id to update.
+     * @param int   $blog_id ID of the site to update.
      * @param array $fields  The fields to update.
      *
@@ -57 +57 @@
 
     /**
-     * Retrieves a site by given blog id.
+     * Retrieves a site by a given ID.
      *
-     * @param int $blog_id The blog id to retrieve.
+     * @param int $blog_id ID of the site to retrieve.
      *
-     * @return null|WP_Site The site object or null if not found.
+     * @return WP_Site|null The site object on success, null on failure.
      */
     public function get_object_by_id( $blog_id ) {