• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp trash post

提供: WordPress Codex 日本語版
移動先: 案内検索

投稿や固定ページをゴミ箱へ移動します。

ゴミ箱機能が無効な場合(デフォルトは有効)、投稿や固定ページは完全に削除されます。

使い方

<?php wp_trash_post( $post_id ); ?>

パラメータ

$post_id
整数) (オプション) 投稿 ID
初期値: 0

戻り値

(mixed) 
ゴミ箱へ移動した投稿のオブジェクト。失敗した場合は false を返します。投稿オブジェクトのステータスは移動後の状態を表します。

用例

WordPress のデフォルト投稿 "Hello World"(投稿 ID が '1')をゴミ箱へ移動する例です。

<?php wp_trash_post( 1 ); ?>

参考

  • ゴミ箱機能が無効なら wp_delete_post() を実行します。wp_trash_post() のフックは実行されません。
  • ゴミ箱へ移動する前に 'wp_trash_post'、移動後に 'trashed_post' の各アクションフックを呼び出します。
  • コメントをゴミ箱へ移動するために wp_trash_post_comments() を使用します。

変更履歴

ソースファイル

wp_trash_post()wp-includes/post.php にあります。

wp_delete_post(), wp_update_post(), wp_delete_attachment(), wp_insert_attachment(), wp_insert_post()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_trash_post最新版との差分