概要
delete_user_meta 関数は、特定のユーザーに関連付けられたメタ情報を削除するために使用されます。この関数は、ユーザーのカスタムデータや設定を管理する際に非常に役立ちます。以下のような状況でよく使われます。
- ユーザーのプロフィール情報をクリーンアップする際
- 不要なユーザーメタデータを削除する際
- プラグインが生成した一時的なデータを削除する際
- ユーザーのアクセス権限に基づいたデータを削除する際
- テストやデバッグ中にユーザーメタ情報をリセットする際
- ユーザー削除時に関連するデータも一緒に削除する際
- 特定のアクション後にメタデータをクリアする際
- ユーザーロールの変更に伴いメタ情報を整理する際
構文
delete_user_meta( $user_id, $meta_key, $meta_value );
パラメータ
$user_id(int): メタ情報を削除する対象ユーザーのID。$meta_key(string): 削除するメタ情報のキー。$meta_value(mixed, optional): 削除するメタ情報の値。指定しない場合、キーに関連付けられたすべての値を削除します。
戻り値
trueが成功した場合、falseが失敗した場合に戻ります。
関連する関数
この関数を使用可能なバージョン
- WordPress 2.9 以降
この関数が含まれるワードプレスのコアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数は特定のWordPressバージョンで非推奨または削除されることはありません。