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

Timestamp:

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

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

@@ -24 +24 @@
         }
 
+        /**
+         * Creates a post object.
+         *
+         * @param array $args Array with elements for the post.
+         *
+         * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
+         */
         function create_object( $args ) {
                 return wp_insert_post( $args );
         }
 
+        /**
+         * Updates an existing post object.
+         *
+         * @param int   $post_id The post id to update.
+         * @param array $fields  Post data.
+         *
+         * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
+         */
         function update_object( $post_id, $fields ) {
                 $fields['ID'] = $post_id;
@@ -33 +48 @@
         }
 
+        /**
+         * Retrieves a object by an id.
+         *
+         * @param int   $post_id The post id to update.
+         *
+         * @return null|WP_Post WP_Post on success or null on failure.
+         */
         function get_object_by_id( $post_id ) {
                 return get_post( $post_id );