Missing $wp_error parameter for wp_insert_attachment

[grapplerulrich]

wp_insert_attachment() uses wp_insert_post() which has a parameter whether to allow return of WP_Error on failure.

It is not possible to do the same for wp_insert_attachment().

This would be my suggested patch.

<?php
function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false ) {
    $defaults = array(
        'file'        => $file,
        'post_parent' => 0
    );
 
    $data = wp_parse_args( $args, $defaults );
 
    if ( ! empty( $parent ) ) {
        $data['post_parent'] = $parent;
    }
 
    $data['post_type'] = 'attachment';
 
    return wp_insert_post( $data, $wp_error );
}

Related: #32318

[DrewAPicture]

Assigning to mark the good-first-bug as "claimed".

[mrahmadawais]

Enhancement: wp_insert_attachment can now return WP_Error on failure

[mrahmadawais]

Oh, looks like I forgot to upload and when I did, there was already a patch. Anywho, I added the docs as well. Looks, like @grapplerulrich your patch has some issue as well. It's removing what you intend to add. Test my patch to see what I am talking about.

[grapplerulrich]

I have updated my patch. I followed the docs in ​https://make.wordpress.org/core/handbook/contribute/git/
Could there be a mistake there in step 4?

[mrahmadawais]

Replying to grapplerulrich:

I have updated my patch. I followed the docs in ​https://make.wordpress.org/core/handbook/contribute/git/
Could there be a mistake there in step 4?

I am using SVN diff at the moment. Will check that later.

@since 4.7.0 Add fourth paramater $wp_error to allow return of WP_Error on failure.

@since is used to depict when was this function introduced. It's not a changelog. So, the line above should not be there. Take a look at my patch https://core.trac.wordpress.org/attachment/ticket/37813/37813.diff and see if there is anything wrong with it. You can use Grunt WP patch ​https://github.com/aaronjorbin/grunt-patch-wordpress to apply the patch.

Let me know.

[grapplerulrich]

I have been asked in the past to add @since to be used as a changelog. e.g. https://core.trac.wordpress.org/ticket/37076#comment:4

[mrahmadawais]

Replying to grapplerulrich:

I have been asked in the past to add @since to be used as a changelog. e.g. https://core.trac.wordpress.org/ticket/37076#comment:4

You are right. I was not aware of this. I think it is a new change. ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#since-section-changelogs

[johnbillion]

@mrahmadawais Tickets remain open until they've been committed to core. Thanks!

[johnbillion]

37813.2.patch​ improves the phrasing and adds a unit test.

[johnbillion]

In 38408:

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

Fixes #37813
Props grapplerulrich, mrahmadawais

[mrahmadawais]

Replying to johnbillion:

@mrahmadawais Tickets remain open until they've been committed to core. Thanks!

Sorry about that. I just wrote the comment and pressed submit. Must have mistakenly clicked at the closed option. My bad! Thanks for the props!