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

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

@@ -13 +13 @@
      * }
      * @param int   $legacy_parent Deprecated.
-     * @param array $legacy_args   Deprecated
+     * @param array $legacy_args   Deprecated.
+     *
+     * @return  int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
      */
     function create_object( $args, $legacy_parent = 0, $legacy_args = array() ) {
@@ -35 +37 @@
     }
 
+    /**
+     * Saves an attachment.
+     *
+     * @param string $file   The file name to create attachment object for.
+     * @param int    $parent The post id to attach the file to.
+     *
+     * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
+     */
     function create_upload_object( $file, $parent = 0 ) {
         $contents = file_get_contents( $file );