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

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

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

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

この項目「関数リファレンス/delete user meta」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

指定した条件に合うメタデータをユーザーから削除します。

キーだけ、またはキーと値を条件に指定できます。キーと値に基づいて削除する場合、同じキーを持つ他のメタデータを削除しません。必要ならキーだけを指定して合致するメタデータをすべて削除できます。

使い方

<?php delete_user_meta( $user_id, $meta_key, $meta_value ) ?>

パラメータ

$user_id
整数) (必須) ユーザー ID。
初期値: なし
$meta_key
文字列) (必須) メタデータの名前。
初期値: なし
$meta_value
mixed) (オプション) メタデータの値。
初期値: ''

戻り値

(真偽値) 
失敗すると False を、成功すると True を返します。

用例

この例は ID が9のユーザーからキーが 'disabled' であるメタデータを削除します。

 
<?php 
$user_id = 9;
delete_user_meta( $user_id, 'disabled' );
?>

戻り値を使って成否を判定する場合は

<?php
if ( ! delete_user_meta( $user_id, '_province' ) ) {
  echo "Ooops! Error while deleting this information!";
}
?>

参考

変更履歴

新規導入: 3.0

ソースファイル

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

関連項目

add_user_meta(), delete_user_meta(), get_user_meta(), update_user_meta(), get_user_option() /en, delete_user_option() /en, update_user_option() /en,


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


最新英語版: WordPress Codex » Function_Reference/delete_user_meta最新版との差分