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

Timestamp:

01/09/2019 05:43:14 AM (7 months ago)

Author:

pento

Message:

Docs: Add docblocks for the PHPUnit factory objects.

Props andizer.
Fixes #44521.

File:

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

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

@@ -24 +24 @@
     }
 
+    /**
+     * Creates a blog object.
+     *
+     * @param array $args Arguments for the site object.
+     *
+     * @return int|WP_Error Returns WP_Error object on failure, the site ID on success.
+     */
     function create_object( $args ) {
         global $wpdb;
@@ -39 +46 @@
     }
 
+    /**
+     * Updates a blog object. Not implemented.
+     *
+     * @param int   $blog_id The blog id to update.
+     * @param array $fields  The fields to update.
+     *
+     * @return void
+     */
     function update_object( $blog_id, $fields ) {}
 
+    /**
+     * Retrieves a site by given blog id.
+     *
+     * @param int $blog_id The blog id to retrieve.
+     *
+     * @return null|WP_Site The site object or null if not found.
+     */
     function get_object_by_id( $blog_id ) {
         return get_site( $blog_id );