- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/wp delete user
提供: WordPress Codex 日本語版
ユーザーを削除して、投稿とリンクを他のユーザーに割り当てます。
もしパラメータとしてユーザーIDが渡されなければ、このユーザーのすべての投稿〔訳注:とリンク?〕は削除されます。投稿が削除されたか再割当されたかに関わらず、この後にアクションフック'delete_user'が起動して、ユーザーIDが渡されます。このユーザーIDにひもづけられたユーザーメタも同様に削除されます。
使用法
<?php wp_delete_user( $id, $reassign ) ?>
パラメータ
- $id
- (integer) (必須) ユーザーID
- 初期値: なし
- $reassign
- (integer) (optional) 投稿とリンクを新たに再割当するユーザーのID.
- 初期値: 'novalue'
戻り値
- (boolean)
- 成功すればtrueがかえってきます。
使用例
注意点
- この関数をプラグインで使う場合は、 ./wp-admin/includes/user.php ファイルをプラグイン機能に入れ込む必要があります。さもなくば、 'call to undefined function' のエラーが起こります。
- 次のグローバル変数利用すること: (object) $wpdb
- これは管理画面用の関数です。
改訂履歴
Version 2.0 にて導入されました。
ソースファイル
wp_delete_user() は wp-admin/includes/user.php
にあります。
関連項目
最新英語版: WordPress Codex » Semantic Markup (最新版との差分)