Make WordPress Core

Changeset 55021


Ignore:
Timestamp:
12/30/2022 02:36:03 AM (17 months ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Rename parameters that use reserved keywords in phpunit/includes/class-wp-unittest-factory-for-attachment.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit:

  • Renames the $parent parameter to $parent_post_id in WP_UnitTest_Factory_For_Attachment::create_upload_object().
  • Amends the $parent_post parameter in wp_insert_attachment() and WP_REST_Revisions_Controller::get_parent() for consistency.

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013], [55014], [55015], [55016], [55017], [55020].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/post.php

    r54961 r55021  
    63286328 * @param string|array $args             Arguments for inserting an attachment.
    63296329 * @param string|false $file             Optional. Filename.
    6330  * @param int          $parent_post      Optional. Parent post ID.
     6330 * @param int          $parent_post_id   Optional. Parent post ID.
    63316331 * @param bool         $wp_error         Optional. Whether to return a WP_Error on failure. Default false.
    63326332 * @param bool         $fire_after_hooks Optional. Whether to fire the after insert hooks. Default true.
    63336333 * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
    63346334 */
    6335 function wp_insert_attachment( $args, $file = false, $parent_post = 0, $wp_error = false, $fire_after_hooks = true ) {
     6335function wp_insert_attachment( $args, $file = false, $parent_post_id = 0, $wp_error = false, $fire_after_hooks = true ) {
    63366336    $defaults = array(
    63376337        'file'        => $file,
     
    63416341    $data = wp_parse_args( $args, $defaults );
    63426342
    6343     if ( ! empty( $parent_post ) ) {
    6344         $data['post_parent'] = $parent_post;
     6343    if ( ! empty( $parent_post_id ) ) {
     6344        $data['post_parent'] = $parent_post_id;
    63456345    }
    63466346
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

    r54970 r55021  
    135135     * @since 4.7.2
    136136     *
    137      * @param int $parent_post Supplied ID.
     137     * @param int $parent_post_id Supplied ID.
    138138     * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.
    139139     */
    140     protected function get_parent( $parent_post ) {
     140    protected function get_parent( $parent_post_id ) {
    141141        $error = new WP_Error(
    142142            'rest_post_invalid_parent',
     
    145145        );
    146146
    147         if ( (int) $parent_post <= 0 ) {
     147        if ( (int) $parent_post_id <= 0 ) {
    148148            return $error;
    149149        }
    150150
    151         $parent_post = get_post( (int) $parent_post );
     151        $parent_post = get_post( (int) $parent_post_id );
    152152
    153153        if ( empty( $parent_post ) || empty( $parent_post->ID )
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php

    r55019 r55021  
    5656     * @since 6.2.0 Returns a WP_Error object on failure.
    5757     *
    58      * @param string $file   The file name to create attachment object for.
    59      * @param int    $parent ID of the post to attach the file to.
     58     * @param string $file           The file name to create attachment object for.
     59     * @param int    $parent_post_id ID of the post to attach the file to.
    6060     *
    6161     * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
    6262     */
    63     public function create_upload_object( $file, $parent = 0 ) {
     63    public function create_upload_object( $file, $parent_post_id = 0 ) {
    6464        $contents = file_get_contents( $file );
    6565        $upload   = wp_upload_bits( wp_basename( $file ), null, $contents );
     
    7979            'post_content'   => '',
    8080            'post_type'      => 'attachment',
    81             'post_parent'    => $parent,
     81            'post_parent'    => $parent_post_id,
    8282            'post_mime_type' => $type,
    8383            'guid'           => $upload['url'],
     
    8585
    8686        // Save the data.
    87         $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent, true );
     87        $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent_post_id, true );
    8888
    8989        if ( is_wp_error( $attachment_id ) ) {
Note: See TracChangeset for help on using the changeset viewer.