Changeset 11357

Timestamp:

12/29/2016 08:26:59 PM (8 years ago)

Author:

boonebgorges

Message:

Fire an action when a cover image is deleted.

The new {$component}_cover_image_deleted action provides
parity with the existing {$component}_cover_image_uploaded
action.

Props jdgrimes.
Fixes #7409.

File:

• trunk/src/bp-core/bp-core-attachments.php (modified) (1 diff)

trunk/src/bp-core/bp-core-attachments.php

@@ -1424 +1424 @@
     // Handle delete.
     if ( bp_attachments_delete_file( array( 'item_id' => $cover_image_data['item_id'], 'object_dir' => $dir, 'type' => 'cover-image' ) ) ) {
+        /**
+         * Fires if the cover image was successfully deleted.
+         *
+         * The dynamic portion of the hook will be xprofile in case of a user's
+         * cover image, groups in case of a group's cover image. For instance:
+         * Use add_action( 'xprofile_cover_image_deleted' ) to run your specific
+         * code once the user has deleted his cover image.
+         *
+         * @since 2.8.0
+         *
+         * @param int $item_id Inform about the item id the cover image was deleted for.
+         */
+        do_action( "{$component}_cover_image_deleted", (int) $cover_image_data['item_id'] );
 
         // Defaults no cover image.