bp_document_delete (|字符串数组args美元='',保龄球从美元=假)
删除文档。
描述
参数
- args美元
-
(数组|字符串)(可选)要删除特定的文档项,使用$args = array('id' => $ids);否则,要使用筛选器删除项,参数格式与BP_Document: get ().请查看该方法的描述。
默认值:“
- 从美元
-
(保龄球)(可选)删除上下文。例如:附件、活动等。
默认值:假
返回
(bool | int)成功时的文档ID。错误的错误。
源
文件:bp-document / bp-document-functions.php
function bp_document_delete($args = ", $from = false){//通过这些变量传递一个或多个下面的变量来删除。$args = bp_parse_args($args, array('id' => false, 'blog_id' => false, 'attachment_id' => false, 'user_id' => false, 'title' => false, 'folder_id' => false, 'activity_id' => false, 'group_id' => false, 'privacy' => false, 'date_created' => false,));/** *在删除文档项之前触发。* * @param array $args用于文档删除的参数数组。* * @since BuddyBoss 1.4.0 */ do_action('bp_before_document_delete', $args);$document_ids_delete = BP_Document::delete($args, $from);If (empty($document_ids_deleted)){返回false;} /** *在文档项被删除后触发。* * @param array $args文档删除时使用的参数数组。* * @since BuddyBoss 1.4.0 */ do_action('bp_document_delete', $args); /** * Fires after the document item has been deleted. * * @param array $document_ids_deleted Array of affected document item IDs. * * @since BuddyBoss 1.4.0 */ do_action( 'bp_document_deleted_documents', $document_ids_deleted ); return true; }
更新日志
版本 | 描述 |
---|---|
BuddyBoss 1.4.0 | 介绍了。 |