Changeset 47913

Timestamp:

06/05/2020 08:28:42 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update the DocBlock for the wp_media_attach_action hook per the documentation standards.

Rename the $att_id variable to $attachment_id for clarity.

Follow-up to [47909].

See #49614.

Location:

trunk

Files:

• src/wp-admin/includes/media.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (2 diffs)

trunk/src/wp-admin/includes/media.php

@@ -3684 +3684 @@
 
 /**
- * Encapsulate logic for Attach/Detach actions
+ * Encapsulates the logic for Attach/Detach actions.
  *
  * @since 4.2.0
@@ -3707 +3707 @@
     $ids = array();
 
-    foreach ( (array) $_REQUEST['media'] as $att_id ) {
-        $att_id = (int) $att_id;
-
-        if ( ! current_user_can( 'edit_post', $att_id ) ) {
+    foreach ( (array) $_REQUEST['media'] as $attachment_id ) {
+        $attachment_id = (int) $attachment_id;
+
+        if ( ! current_user_can( 'edit_post', $attachment_id ) ) {
             continue;
         }
 
-        $ids[] = $att_id;
+        $ids[] = $attachment_id;
     }
 
@@ -3728 +3728 @@
 
     if ( isset( $result ) ) {
-        foreach ( $ids as $att_id ) {
+        foreach ( $ids as $attachment_id ) {
             /**
-             * Fires when media is attached/detached from a post.
+             * Fires when media is attached or detached from a post.
              *
-             * @since 5.5
+             * @since 5.5.0
              *
-             * @param string $action    Attach/detach action.
-             * @param int    $att_id    The attachment ID.
-             * @param int    $parent_id Attachment parent ID.
+             * @param string $action        Attach/detach action. Accepts 'attach' or 'detach'.
+             * @param int    $attachment_id The attachment ID.
+             * @param int    $parent_id     Attachment parent ID.
              */
-            do_action( 'wp_media_attach_action', $action, $att_id, $parent_id );
-
-            clean_attachment_cache( $att_id );
+            do_action( 'wp_media_attach_action', $action, $attachment_id, $parent_id );
+
+            clean_attachment_cache( $attachment_id );
         }
 

trunk/tests/phpunit/tests/rest-api/rest-controller.php

@@ -270 +270 @@
         }
 
-        // ignored properties
+        // Ignored properties.
         $this->assertArrayNotHasKey( 'ignored_prop', $args['someobject'] );
 
@@ -276 +276 @@
 
     /**
-     * @dataProvider data_get_fields_for_response,
+     * @dataProvider data_get_fields_for_response
      */
     public function test_get_fields_for_response( $param, $expected ) {