wp_trash_post

Move a post or page to the Trash.

Description

(false|array|WP_Post|null) wp_trash_post( (int) $post_id = 0 ); 

If trash is disabled, the post or page is permanently deleted.

Returns (false|array|WP_Post|null)

Post data array, otherwise false.

Parameters (1)

0. $post_id — Optional. (int)
Post ID. Default is ID of the global $post if EMPTY_TRASH_DAYS equals true.

Usage

  1. if ( !function_exists( 'wp_trash_post' ) ) { 
  2.     require_once ABSPATH . WPINC . '/post.php'; 
  3. } 
  4.   
  5. // Optional. Post ID. Default is ID of the global $post 
  6. // if EMPTY_TRASH_DAYS equals true. 
  7. $post_id = -1; 
  8.   
  9. // NOTICE! Understand what this does before running. 
  10. $result = wp_trash_post($post_id); 
  11.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/post.php  
  1. function wp_trash_post( $post_id = 0 ) { 
  2.     if ( !EMPTY_TRASH_DAYS ) 
  3.         return wp_delete_post($post_id, true); 
  4.  
  5.     if ( !$post = get_post($post_id, ARRAY_A) ) 
  6.         return $post; 
  7.  
  8.     if ( $post['post_status'] == 'trash' ) 
  9.         return false; 
  10.  
  11.     /** 
  12.      * Fires before a post is sent to the trash. 
  13.      * 
  14.      * @since 3.3.0 
  15.      * 
  16.      * @param int $post_id Post ID. 
  17.      */ 
  18.     do_action( 'wp_trash_post', $post_id ); 
  19.  
  20.     add_post_meta($post_id, '_wp_trash_meta_status', $post['post_status']); 
  21.     add_post_meta($post_id, '_wp_trash_meta_time', time()); 
  22.  
  23.     $post['post_status'] = 'trash'; 
  24.     wp_insert_post( wp_slash( $post ) ); 
  25.  
  27.  
  28.     /** 
  29.      * Fires after a post is sent to the trash. 
  30.      * 
  31.      * @since 2.9.0 
  32.      * 
  33.      * @param int $post_id Post ID. 
  34.      */ 
  35.     do_action( 'trashed_post', $post_id ); 
  36.  
  37.     return $post; 
  38. }