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

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

関数リファレンス/wp delete user

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

ユーザーを削除します。投稿とリンクを他のユーザーへ割り当てることもできます。

もし $reassign パラメータにユーザー ID が渡されなければ、削除するユーザーのすべての投稿(訳注:とリンク?)は削除されます。このユーザー ID に紐付けられたユーザーメタも同様に削除されます。

投稿が再割当または削除される前に、アクション 'delete_user' が起動して $id$reassign が渡されます。ユーザーが削除された後、アクション 'deleted_user' が起動して $id$reassign が渡されます。

使用法

<?php wp_delete_user( $id, $reassign ); ?>

パラメータ

$id
整数) (必須) ユーザー ID。
初期値: なし
$reassign
整数) (オプション) 投稿とリンクを再割当するユーザーの ID。
初期値: null – 再割当せず削除

参考: $reassign に 'novalue'(昔のデフォルト値)を指定すると null と見なされます。

戻り値

(真偽値) 
成功すれば true が返されます。

用例

ユーザーが自分でアカウントを削除できるようにします。

if ( is_user_logged_in() && ! empty( $_GET['DeleteMyAccount'] ) ) {
	add_action( 'init', 'remove_logged_in_user' );
}

function remove_logged_in_user() {
	// Verify that the user intended to take this action.
	if ( ! wp_verify_nonce( 'delete_account' ) ) {
		return;
	}

	require_once(ABSPATH.'wp-admin/includes/user.php' );
	$current_user = wp_get_current_user();
	wp_delete_user( $current_user->ID );
}

注意点

  • この関数をプラグインで使うには ./wp-admin/includes/user.php ファイルをプラグイン機能に include する必要があります。さもなくば 'call to undefined function' のエラーが起こります。
  • グローバル変数 (オブジェクト) $wpdb を使用します。
  • これは管理画面用の関数です。
  • do_action() を用いて 'delete_user''deleted_user' フックを呼び出します。

改訂履歴

新規導入: 2.0

ソースファイル

wp_delete_user()wp-admin/includes/user.php にあります。


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


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