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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/delete_user_meta 07:12, 5 May 2016 Mynamevenu24 版を流し込み。)
 
(和訳完了。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
== Description ==
+
== 説明<span id="Description"></span> ==
Remove metadata matching criteria from a user.
+
  
You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
+
指定した条件に合うメタデータをユーザーから削除します。
 +
 
 +
キーだけ、またはキーと値を条件に指定できます。キーと値に基づいて削除する場合、同じキーを持つ他のメタデータを削除しません。必要ならキーだけを指定して合致するメタデータをすべて削除できます。
 +
 
 +
== 使い方<span id="Usage"></span> ==
  
== Usage ==
 
 
  <?php delete_user_meta( $user_id, $meta_key, $meta_value ) ?>
 
  <?php delete_user_meta( $user_id, $meta_key, $meta_value ) ?>
  
== Parameters ==
+
== パラメータ<span id="Parameters"></span> ==
{{Parameter|$user_id|integer|user ID}}
+
{{Parameter|$meta_key|string|Metadata name.}}
+
{{Parameter|$meta_value|mixed|Metadata value.|optional|&#39;&#39;}}
+
  
== Return Values ==
+
{{Parameter|$user_id|整数|ユーザー ID。}}
; (boolean) : False for failure. True for success.
+
{{Parameter|$meta_key|文字列|メタデータの名前。}}
 +
{{Parameter|$meta_value|mixed|メタデータの値。|オプション|&#39;&#39;}}
  
== Examples ==
+
== 戻り値<span id="Return Values"></span> ==
This example will delete the meta_key is 'disabled' for user id 9.
+
 
 +
; (真偽値) : 失敗すると False を、成功すると True を返します。
 +
 
 +
== 用例<span id="Examples"></span> ==
 +
 
 +
この例は ID が9のユーザーからキーが 'disabled' であるメタデータを削除します。
  
 
<pre>  
 
<pre>  
 
<?php  
 
<?php  
 
$user_id = 9;
 
$user_id = 9;
delete_user_meta($user_id, 'disabled');
+
delete_user_meta( $user_id, 'disabled' );
 
?>
 
?>
 
</pre>
 
</pre>
  
Using if condition
+
戻り値を使って成否を判定する場合は
 +
 
 
<pre>
 
<pre>
 
<?php
 
<?php
if ( ! delete_user_meta($user_id, '_province') ) {
+
if ( ! delete_user_meta( $user_id, '_province' ) ) {
 
   echo "Ooops! Error while deleting this information!";
 
   echo "Ooops! Error while deleting this information!";
 
}
 
}
36行目: 42行目:
 
</pre>
 
</pre>
  
== Notes ==
+
== 参考<span id="Notes"></span> ==
* Uses: [[Function_Reference/delete_metadata|<tt>delete_metadata()</tt>]]
+
 
 +
* 内部で [[関数リファレンス/delete_metadata|<tt>delete_metadata()</tt>]] を使います。
 +
 
 +
== 変更履歴<span id="Change Log"></span> ==
 +
 
 +
新規導入: [[Version_3.0|3.0]]
 +
 
 +
== ソースファイル<span id="Source_File"></span> ==
  
== Change Log ==
+
<tt>delete_user_meta()</tt> は {{Trac|wp-includes/user.php}} にあります。
Since: [[Version_3.0|3.0]]
+
  
== Source File ==
+
== 関連項目<span id="Related"></span> ==
<tt>delete_user_meta()</tt> is located in {{Trac|wp-includes/user.php}}.
+
  
== Related ==
 
 
{{User Meta Tags}}
 
{{User Meta Tags}}
 
{{Tag Footer}}
 
{{Tag Footer}}

2017年5月7日 (日) 22:57時点における最新版

この項目「関数リファレンス/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最新版との差分