Changeset 55021

Timestamp:

12/30/2022 02:36:03 AM (22 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:

• src/wp-includes/post.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php (modified) (2 diffs)
• tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php (modified) (3 diffs)

trunk/src/wp-includes/post.php

@@ -6328 +6328 @@
  * @param string|array $args             Arguments for inserting an attachment.
  * @param string|false $file             Optional. Filename.
- * @param int          $parent_post      Optional. Parent post ID.
+ * @param int          $parent_post_id   Optional. Parent post ID.
  * @param bool         $wp_error         Optional. Whether to return a WP_Error on failure. Default false.
  * @param bool         $fire_after_hooks Optional. Whether to fire the after insert hooks. Default true.
  * @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_post = 0, $wp_error = false, $fire_after_hooks = true ) {
+function wp_insert_attachment( $args, $file = false, $parent_post_id = 0, $wp_error = false, $fire_after_hooks = true ) {
     $defaults = array(
         'file'        => $file,
@@ -6341 +6341 @@
     $data = wp_parse_args( $args, $defaults );
 
-    if ( ! empty( $parent_post ) ) {
-        $data['post_parent'] = $parent_post;
+    if ( ! empty( $parent_post_id ) ) {
+        $data['post_parent'] = $parent_post_id;
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -135 +135 @@
      * @since 4.7.2
      *
-     * @param int $parent_post Supplied ID.
+     * @param int $parent_post_id Supplied ID.
      * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.
      */
-    protected function get_parent( $parent_post ) {
+    protected function get_parent( $parent_post_id ) {
         $error = new WP_Error(
             'rest_post_invalid_parent',
@@ -145 +145 @@
         );
 
-        if ( (int) $parent_post <= 0 ) {
+        if ( (int) $parent_post_id <= 0 ) {
             return $error;
         }
 
-        $parent_post = get_post( (int) $parent_post );
+        $parent_post = get_post( (int) $parent_post_id );
 
         if ( empty( $parent_post ) || empty( $parent_post->ID )

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php

@@ -56 +56 @@
      * @since 6.2.0 Returns a WP_Error object on failure.
      *
-     * @param string $file   The file name to create attachment object for.
-     * @param int    $parent ID of the post to attach the file to.
+     * @param string $file           The file name to create attachment object for.
+     * @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.
      */
-    public function create_upload_object( $file, $parent = 0 ) {
+    public function create_upload_object( $file, $parent_post_id = 0 ) {
         $contents = file_get_contents( $file );
         $upload   = wp_upload_bits( wp_basename( $file ), null, $contents );
@@ -79 +79 @@
             'post_content'   => '',
             'post_type'      => 'attachment',
-            'post_parent'    => $parent,
+            'post_parent'    => $parent_post_id,
             'post_mime_type' => $type,
             'guid'           => $upload['url'],
@@ -85 +85 @@
 
         // Save the data.
-        $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent, true );
+        $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent_post_id, true );
 
         if ( is_wp_error( $attachment_id ) ) {