bp_folder_delete( array|string $args )
Delete folder item.
Description
Parameters
- $args
-
(Required) To delete specific folder items, use $args = array( 'id' => $ids ); Otherwise, to use filters for item deletion, the argument format is the same as BP_Document_Folder::get(). See that method for a description.
Return
(bool) True on Success. False on error.
Source
File: bp-document/bp-document-functions.php
function bp_folder_delete( $args ) {
// Pass one or more the of following variables to delete by those variables.
$args = bp_parse_args(
$args,
array(
'id' => false,
'user_id' => false,
'group_id' => false,
'date_created' => false,
)
);
/**
* Fires before an folder item proceeds to be deleted.
*
* @param array $args Array of arguments to be used with the folder deletion.
*
* @since BuddyBoss 1.4.0
*/
do_action( 'bp_before_folder_delete', $args );
$folder_ids_deleted = BP_Document_Folder::delete( $args );
if ( empty( $folder_ids_deleted ) ) {
return false;
}
/**
* Fires after the folder item has been deleted.
*
* @param array $args Array of arguments used with the folder deletion.
*
* @since BuddyBoss 1.4.0
*/
do_action( 'bp_folder_delete', $args );
/**
* Fires after the folder item has been deleted.
*
* @param array $folder_ids_deleted Array of affected folder item IDs.
*
* @since BuddyBoss 1.4.0
*/
do_action( 'bp_folders_deleted_folders', $folder_ids_deleted );
return true;
}
Changelog
| Version | Description |
|---|---|
| BuddyBoss 1.4.0 | Introduced. |
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.