Changeset 13995 for trunk/wp-includes/post.php

Timestamp:

04/04/2010 12:20:19 PM (15 years ago)

Author:

nacin

Message:

Add $force_delete to wp_delete_comment(). see #12766, see #11470.

File:

• trunk/wp-includes/post.php (modified) (7 diffs)

trunk/wp-includes/post.php

@@ -1593 +1593 @@
 
 /**
- * Removes a post, attachment, or page.
- *
- * When the post and page goes, everything that is tied to it is deleted also.
+ * Trashes or deletes a post or page.
+ *
+ * When the post and page is permanently deleted, everything that is tied to it is deleted also.
  * This includes comments, post meta fields, and terms associated with the post.
+ *
+ * The post or page is moved to trash instead of permanently deleted unless trash is
+ * disabled, item is already in the trash, or $force_delete is true.
  *
  * @since 1.0.0
@@ -1602 +1605 @@
  * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'.
  * @uses wp_delete_attachment() if post type is 'attachment'.
+ * @uses wp_trash_post() if item should be trashed.
  *
  * @param int $postid Post ID.
- * @param bool $force_delete Whether to bypass trash and force deletion
+ * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
  * @return mixed False on failure
  */
@@ -1613 +1617 @@
         return $post;
 
-    if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS > 0 )
+    if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS )
             return wp_trash_post($postid);
 
@@ -1699 +1703 @@
  * Moves a post or page to the Trash
  *
+ * If trash is disabled, the post or page is permanently deleted.
+ *
  * @since 2.9.0
  * @uses do_action() on 'trash_post' before trashing
  * @uses do_action() on 'trashed_post' after trashing
+ * @uses wp_delete_post() if trash is disabled
  *
  * @param int $postid Post ID.
@@ -1707 +1714 @@
  */
 function wp_trash_post($post_id = 0) {
-    if ( EMPTY_TRASH_DAYS == 0 )
-        return wp_delete_post($post_id);
+    if ( !EMPTY_TRASH_DAYS )
+        return wp_delete_post($post_id, true);
 
     if ( !$post = wp_get_single_post($post_id, ARRAY_A) )
@@ -3297 +3304 @@
 
 /**
- * Delete an attachment.
- *
- * Will remove the file also, when the attachment is removed. Removes all post
- * meta fields, taxonomy, comments, etc associated with the attachment (except
- * the main post).
+ * Trashes or deletes an attachment.
+ *
+ * When an attachment is permanently deleted, the file will also be removed.
+ * Deletion removes all post meta fields, taxonomy, comments, etc. associated
+ * with the attachment (except the main post).
+ *
+ * The attachment is moved to the trash instead of permanently deleted unless trash
+ * for media is disabled, item is already in the trash, or $force_delete is true.
  *
  * @since 2.0.0
@@ -3308 +3318 @@
  *
  * @param int $postid Attachment ID.
- * @param bool $force_delete Whether to bypass trash and force deletion
+ * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
  * @return mixed False on failure. Post data on success.
  */