WordPress.org

Languages: English • 日本語 (Add your language)

Description

Moves a post or page to the Trash

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

Usage

 <?php wp_trash_post( $post_id  ); ?>

Parameters

$post_id

(integer) (optional) Post ID.

Default: 0

Return Values

(mixed) 

False on failure.

Examples

Trash the default WordPress Post, "Hello World," which has an ID of '1'. <?php wp_trash_post( 1 ); ?>

Notes

• Uses: do_action() on 'wp_trash_post' before trashing.
• Uses: do_action() on 'trashed_post' after trashing.
• Uses: wp_trash_post_comments()
• Uses: wp_delete_post() if trash is disabled.

Change Log

Since: 2.9.0

Source File

wp_trash_post() is located in wp-includes/post.php.

Related

Post, Page, Attachment and Bookmarks Functions: wp_delete_post(), wp_update_post(), wp_delete_attachment(), wp_insert_attachment(), wp_insert_post()