bp_attachments_cover_image_ajax_delete()

Ajax delete a cover photo for a given object and item id.

Description

Return

(string|null) A json object containing success data if the cover photo was deleted error message otherwise.

Source

function bp_attachments_cover_image_ajax_delete() {
    if ( ! bp_is_post_request() ) {
        wp_send_json_error();
    }
 
    if ( empty( $_POST['object'] ) || empty( $_POST['item_id'] ) ) {
        wp_send_json_error();
    }
 
    $args = array(
        'object'  => sanitize_text_field( $_POST['object'] ),
        'item_id' => (int) $_POST['item_id'],
    );
 
    // Check permissions.
    check_admin_referer( 'bp_delete_cover_image', 'nonce' );
    if ( ! bp_attachments_current_user_can( 'edit_cover_image', $args ) ) {
        wp_send_json_error();
    }
 
    // Set object for the user's case.
    if ( 'user' === $args['object'] ) {
        $component = 'xprofile';
        $dir       = 'members';
 
    // Set it for any other cases.
    } else {
        $component = $args['object'] . 's';
        $dir       = $component;
    }
 
    // Handle delete.
    if ( bp_attachments_delete_file( array( 'item_id' => $args['item_id'], 'object_dir' => $dir, 'type' => 'cover-image' ) ) ) {
        /**
         * Fires if the cover photo was successfully deleted.
         *
         * The dynamic portion of the hook will be xprofile in case of a user's
         * cover photo, groups in case of a group's cover photo. For instance:
         * Use add_action( 'xprofile_cover_image_deleted' ) to run your specific
         * code once the user has deleted his cover photo.
         *
         * @since BuddyPress 2.8.0
         *
         * @param int $item_id Inform about the item id the cover photo was deleted for.
         */
        do_action( "{$component}_cover_image_deleted", (int) $args['item_id'] );
 
        $response = array(
            'reset_url'     => '',
            'feedback_code' => 3,
        );
 
        // Get cover photo settings in case there's a default header.
        $cover_params = bp_attachments_get_cover_image_settings( $component );
 
        // Check if there's a default cover.
        if ( ! empty( $cover_params['default_cover'] ) ) {
            $response['reset_url'] = $cover_params['default_cover'];
        }
 
        wp_send_json_success( $response );
 
    } else {
        wp_send_json_error( array(
            'feedback_code' => 2,
        ) );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.4.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-functions.php: bp_is_post_request()	Return true\|false if this is a POST request.
bp-core/bp-core-attachments.php: {$component}_cover_image_deleted	Fires if the cover photo was successfully deleted.
bp-core/bp-core-attachments.php: bp_attachments_current_user_can()	Check the current user’s capability to edit an avatar for a given object.
bp-core/bp-core-attachments.php: bp_attachments_get_cover_image_settings()	Get the cover photo settings
bp-core/bp-core-attachments.php: bp_attachments_delete_file()	Delete an attachment for the given arguments

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents