Remove new_postarr from doc in wp_insert_post function

[mukesh27]

$new_postarr is not used but it is mentioned in the documentation of the wp_insert_post() function.

[mukesh27]

updated patch with file path

[johnbillion]

Thanks for the patch @mukesh27. $new_postarr is the name given to the third of four parameters passed to this filter. Am I missing something?

[mukesh27]

Thank you for your reply @johnbillion. You can check online link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/post.php#L3575 filter wp_insert_post_parent contain one array variable $postarr.

[peterwilsoncc]

Replying to mukesh27:

You can check online link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/post.php#L3575 filter wp_insert_post_parent contain one array variable $postarr.

The documentation for filters can be a little confusing.

The parameter names are for the function that the filter calls, rather than as passed. In this case compact( array_keys( $postarr ) ) is expected to be named $new_postarr in the called function.

The code you link to is a shorter way of writing:

<?php
$new_postarr = compact( array_keys( $postarr ) );
$post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, $new_postarr, $postarr );

I'm going to close this ticket as invalid, which is trac's unfriendly way of documenting no change is needed.

[mukesh27]

@peterwilsoncc my question is that we have to add code relate $new_postarr = compact( array_keys( $postarr ) ); and pass it to filter then doc elements are right as per written.

Need to add update code file like you suggested.

<?php
$new_postarr = compact( array_keys( $postarr ) );
$post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, $new_postarr, $postarr );

Replying to peterwilsoncc:

Replying to mukesh27:

You can check online link https://core.trac.wordpress.org/browser/trunk/src/wp-includes/post.php#L3575 filter wp_insert_post_parent contain one array variable $postarr.

The documentation for filters can be a little confusing.

The parameter names are for the function that the filter calls, rather than as passed. In this case compact( array_keys( $postarr ) ) is expected to be named $new_postarr in the called function.

The code you link to is a shorter way of writing:

<?php
$new_postarr = compact( array_keys( $postarr ) );
$post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, $new_postarr, $postarr );

I'm going to close this ticket as invalid, which is trac's unfriendly way of documenting no change is needed.

[pento]

The coding standards project is looking at the best way to manage situations like this, so I'm moving this out of 5.1, until there's a decision on that.