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

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

「関数リファレンス/wp delete user」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(関連項目)
(en:Function Reference/wp delete user 13:10, 5 June 2015 Jonua 版を反映。deleted_user フックを追記。)
 
2行目: 2行目:
 
== 解説 ==
 
== 解説 ==
 
</div>
 
</div>
ユーザーを削除して、投稿とリンクを他のユーザーに割り当てます。
+
ユーザーを削除します。投稿とリンクを他のユーザーへ割り当てることもできます。
  
もしパラメータとしてユーザーIDが渡されなければ、このユーザーのすべての投稿〔訳注:とリンク?〕は削除されます。投稿が削除されたか再割当されたかに関わらず、この後にアクションフック'<tt>delete_user</tt>'が起動して、ユーザーIDが渡されます。このユーザーIDにひもづけられたユーザーメタも同様に削除されます。
+
もし <tt>$reassign</tt> パラメータにユーザー ID が渡されなければ、削除するユーザーのすべての投稿(訳注:とリンク?)は削除されます。このユーザー ID に紐付けられたユーザーメタも同様に削除されます。
 +
 
 +
投稿が再割当または削除される前に、アクション '<tt>delete_user</tt>' が起動して <tt>$id</tt> と <tt>$reassign</tt> が渡されます。ユーザーが削除された後、アクション '<tt>deleted_user</tt>' が起動して <tt>$id</tt> と <tt>$reassign</tt> が渡されます。
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使用法 ==
 
== 使用法 ==
 
</div>
 
</div>
<pre>
+
<?php wp_delete_user( $id, $reassign ); ?>
&lt;?php wp_delete_user( $id, $reassign ) ?&gt;
+
</pre>
+
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$id|integer|ユーザーID}}
+
{{Parameter|$id|整数|ユーザー ID。}}
{{Parameter|$reassign|integer|投稿とリンクを新たに再割当するユーザーのID.|optional|'novalue'}}
+
{{Parameter|$reassign|整数|投稿とリンクを再割当するユーザーの ID。|オプション|null &ndash; 再割当せず削除}}
 +
 
 +
参考: $reassign に 'novalue'(昔のデフォルト値)を指定すると null と見なされます。
  
 
<div id="Return_Values">
 
<div id="Return_Values">
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
; (boolean) : 成功すればtrueがかえってきます。
+
; (真偽値) : 成功すれば true が返されます。
  
 
<div id="Examples">
 
<div id="Examples">
== 使用例 ==
+
== 用例 ==
 
</div>
 
</div>
<!-- Need creative examples. Feel free to link to external examples. -->
+
ユーザーが自分でアカウントを削除できるようにします。
 +
 
 +
<pre>
 +
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 );
 +
}
 +
</pre>
  
 
<div id="Notes">
 
<div id="Notes">
 
== 注意点 ==
 
== 注意点 ==
 
</div>
 
</div>
* この関数をプラグインで使う場合は、 <tt>./wp-admin/includes/user.php</tt> ファイルをプラグイン機能に入れ込む必要があります。さもなくば、 <tt>'call to undefined function'</tt> のエラーが起こります。
+
* この関数をプラグインで使うには <tt>./wp-admin/includes/user.php</tt> ファイルをプラグイン機能に include する必要があります。さもなくば <tt>'call to undefined function'</tt> のエラーが起こります。
* 次のグローバル変数利用すること: (<tt>object</tt>) [[関数リファレンス/wpdb_Class|<tt>$wpdb</tt>]]
+
* グローバル変数 (<tt>オブジェクト</tt>) [[関数リファレンス/wpdb_Class|<tt>$wpdb</tt>]] を使用します。
 
* これは管理画面用の関数です。
 
* これは管理画面用の関数です。
 +
* [[関数リファレンス/do_action|<tt>do_action()</tt>]] を用いて [[プラグイン API/アクションフック一覧/delete_user|'delete_user']] と [[プラグイン API/アクションフック一覧/deleted_user|'deleted_user']] フックを呼び出します。
  
<div id="Change Log">
+
<div id="Change_Log">
 
== 改訂履歴 ==
 
== 改訂履歴 ==
 
</div>
 
</div>
Version 2.0 にて導入されました。
+
新規導入: 2.0
  
<div id="Source File">
+
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
50行目: 70行目:
 
</div>
 
</div>
  
{{原文|Semantic Markup |134312}}<!-- 13:21, 9 August 2013 Djkaz  版 -->
+
{{Tag Footer}}
  
 +
{{原文|Function Reference/wp_delete_user|151940}} <!-- 13:10, 5 June 2015 Jonua 版 -->
  
 +
{{DEFAULTSORT:Wp_delete_user}}
 
[[Category:関数]]
 
[[Category:関数]]
 +
 +
[[en:Function Reference/wp delete user]]

2016年3月27日 (日) 17:03時点における最新版

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

もし $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最新版との差分