Changeset 46985 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.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-user.php (modified) (3 diffs)

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

@@ -27 +27 @@
      * @param array $args The user data to insert.
      *
-     * @return int|WP_Error
+     * @return int|WP_Error The user ID on success, WP_Error object on failure.
      */
     public function create_object( $args ) {
@@ -36 +36 @@
      * Updates the user data.
      *
-     * @param int   $user_id The user id to update.
+     * @param int   $user_id ID of the user to update.
      * @param array $fields  The user data to update.
      *
-     * @return int|WP_Error User id on success. WP_Error on failure.
+     * @return int|WP_Error The user ID on success, WP_Error object on failure.
      */
     public function update_object( $user_id, $fields ) {
@@ -47 +47 @@
 
     /**
-     * Retrieves the user for given user id.
+     * Retrieves the user for a given ID.
      *
-     * @param int $user_id The user id to get.
+     * @param int $user_id ID of the user ID to retrieve.
      *
-     * @return WP_User The user.
+     * @return WP_User The user object.
      */
     public function get_object_by_id( $user_id ) {