Docs: Clarify description for ::create_upload_object in the attachment test factory.

SergeyBiryukov · SergeyBiryukov · commit 4e96d756dfbe · 2025-06-06T09:29:41.000Z
Follow-up to [34855], [44497]. See #63166. git-svn-id: https://develop.svn.wordpress.org/trunk@60289 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php b/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php
@@ -50,12 +50,13 @@ public function create_object( $args, $legacy_parent = 0, $legacy_args = array()
 	}
 
 	/**
-	 * Saves an attachment.
+	 * Saves a file as an attachment.
 	 *
 	 * @since 4.4.0
 	 * @since 6.2.0 Returns a WP_Error object on failure.
 	 *
-	 * @param string $file           The file name to create attachment object for.
+	 * @param string $file           Full path to the file to create an attachment object for.
+	 *                               The name of the file will be used as the attachment name.
 	 * @param int    $parent_post_id ID of the post to attach the file to.
 	 *
 	 * @return int|WP_Error The attachment ID on success, WP_Error object on failure.

Original file line number	Diff line number	Diff line change
`@@ -50,12 +50,13 @@ public function create_object( $args, $legacy_parent = 0, $legacy_args = array()`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`53`		`- * Saves an attachment.`
	`53`	`+ * Saves a file as an attachment.`
`54`	`54`	`*`
`55`	`55`	`* @since 4.4.0`
`56`	`56`	`* @since 6.2.0 Returns a WP_Error object on failure.`
`57`	`57`	`*`
`58`		`- * @param string $file The file name to create attachment object for.`
	`58`	`+ * @param string $file Full path to the file to create an attachment object for.`
	`59`	`+ * The name of the file will be used as the attachment name.`
`59`	`60`	`* @param int $parent_post_id ID of the post to attach the file to.`
`60`	`61`	`*`
`61`	`62`	`* @return int\|WP_Error The attachment ID on success, WP_Error object on failure.`