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

Timestamp:

12/18/2019 12:17:54 AM (4 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-post.php (modified) (2 diffs)

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

@@ -38 +38 @@
      * Updates an existing post object.
      *
-     * @param int   $post_id The post id to update.
+     * @param int   $post_id ID of the post to update.
      * @param array $fields  Post data.
      *
-     * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
+     * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
      */
     public function update_object( $post_id, $fields ) {
@@ -49 +49 @@
 
     /**
-     * Retrieves a object by an id.
+     * Retrieves a post by a given ID.
      *
-     * @param int   $post_id The post id to update.
+     * @param int $post_id ID of the post to retrieve.
      *
-     * @return null|WP_Post WP_Post on success or null on failure.
+     * @return WP_Post|null WP_Post object on success, null on failure.
      */
     public function get_object_by_id( $post_id ) {