Question

wp_trash_post( int $post_id )

Move a post or page to the Trash

---

description

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

---

参数

$post_id

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

---

返回值

(false|array|WP_Post|null) Post data array, otherwise false.

---

源代码

File: wp-includes/post.php

function wp_trash_post( $post_id = 0 ) {
	if ( !EMPTY_TRASH_DAYS )
		return wp_delete_post($post_id, true);

	if ( !$post = get_post($post_id, ARRAY_A) )
		return $post;

	if ( $post['post_status'] == 'trash' )
		return false;

	/**
	 * Fires before a post is sent to the trash.
	 *
	 * @since 3.3.0
	 *
	 * @param int $post_id Post ID.
	 */
	do_action( 'wp_trash_post', $post_id );

	add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']);
	add_post_meta($post_id,'_wp_trash_meta_time', time());

	$post['post_status'] = 'trash';
	wp_insert_post( wp_slash( $post ) );

	wp_trash_post_comments($post_id);

	/**
	 * Fires after a post is sent to the trash.
	 *
	 * @since 2.9.0
	 *
	 * @param int $post_id Post ID.
	 */
	do_action( 'trashed_post', $post_id );

	return $post;
}

---

更新日志

Version	description
2.9.0	Introduced.

---

相关函数

Uses

• wp-includes/formatting.php: wp_slash()
• wp-includes/plugin.php: do_action()
• wp-includes/post.php: wp_insert_post()
• wp-includes/post.php: wp_delete_post()
• wp-includes/post.php: wp_trash_post_comments()
• wp-includes/post.php: wp_trash_post
• wp-includes/post.php: trashed_post
• wp-includes/post.php: add_post_meta()
• wp-includes/post.php: get_post()
Show 4 more uses Hide more uses

---

Used By

• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::delete_item()
• wp-admin/includes/ajax-actions.php: wp_ajax_trash_post()
• wp-includes/post.php: wp_delete_attachment()
• wp-includes/post.php: wp_delete_post()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Basic Example

   Trash the default WordPress Post, “Hello World,” which has an ID of ‘1’.

   
   <?php wp_trash_post( $post_id = 1 ); ?>