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

Timestamp:

01/09/2019 05:43:14 AM (6 years 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-user.php (modified) (2 diffs)

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

@@ -22 +22 @@
     }
 
+    /**
+     * Inserts an user.
+     *
+     * @param array $args The user data to insert.
+     *
+     * @return int|WP_Error
+     */
     function create_object( $args ) {
         return wp_insert_user( $args );
     }
 
+    /**
+     * Updates the user data.
+     *
+     * @param int   $user_id The user id to update.
+     * @param array $fields  The user data to update.
+     *
+     * @return int|WP_Error User id on success. WP_Error on failure.
+     */
     function update_object( $user_id, $fields ) {
         $fields['ID'] = $user_id;
@@ -31 +46 @@
     }
 
+    /**
+     * Retrieves the user for given user id.
+     *
+     * @param int $user_id The user id to get.
+     *
+     * @return WP_User The user.
+     */
     function get_object_by_id( $user_id ) {
         return new WP_User( $user_id );