Changeset 38408

Timestamp:

08/27/2016 05:24:58 PM (8 years ago)

Author:

johnbillion

Message:

Media: Add a $wp_error parameter to wp_insert_attachment() to give it parity with wp_insert_post().

Fixes #37813
Props grapplerulrich, mrahmadawais

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (3 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -2867 +2867 @@
  *     @type array  $meta_input            Array of post meta values keyed by their post meta key. Default empty.
  * }
- * @param bool  $wp_error Optional. Whether to allow return of WP_Error on failure. Default false.
+ * @param bool  $wp_error Optional. Whether to return a WP_Error on failure. Default false.
  * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
  */
@@ -4695 +4695 @@
  *
  * @since 2.0.0
+ * @since 4.7.0 Added the `$wp_error` parameter to allow a WP_Error to be returned on failure.
  *
  * @see wp_insert_post()
  *
- * @param string|array $args   Arguments for inserting an attachment.
- * @param string       $file   Optional. Filename.
- * @param int          $parent Optional. Parent post ID.
- * @return int Attachment ID.
- */
-function wp_insert_attachment( $args, $file = false, $parent = 0 ) {
+ * @param string|array $args     Arguments for inserting an attachment.
+ * @param string       $file     Optional. Filename.
+ * @param int          $parent   Optional. Parent post ID.
+ * @param bool         $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
+ */
+function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false ) {
     $defaults = array(
         'file'        => $file,
@@ -4717 +4719 @@
     $data['post_type'] = 'attachment';
 
-    return wp_insert_post( $data );
+    return wp_insert_post( $data, $wp_error );
 }
 

trunk/tests/phpunit/tests/media.php

@@ -1797 +1797 @@
         return $data;
     }
+
+    /**
+     * @ticket 37813
+     */
+    public function test_return_type_when_inserting_attachment_with_error_in_data() {
+        $data = array(
+            'post_status'  => 'public',
+            'post_content' => 'Attachment content',
+            'post_title'   => 'Attachment Title',
+            'post_date'    => '2012-02-30 00:00:00',
+        );
+
+        $attachment_id = wp_insert_attachment( $data, '', 0, true );
+        $this->assertWPError( $attachment_id );
+        $this->assertEquals( 'invalid_date', $attachment_id->get_error_code() );
+
+        $attachment_id = wp_insert_attachment( $data, '', 0 );
+        $this->assertSame( 0, $attachment_id );
+    }
 }