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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/delete post meta 20:44, 7 July 2009 Ramiy)
 
(全体を和訳)
1行目: 1行目:
==Description==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
This function deletes all custom fields with the specified key from the specified post. See also [[Function Reference/update post meta|update_post_meta()]], [[Function Reference/get post meta|get_post_meta()]] and [[Function Reference/add post meta|add_post_meta()]].
+
この関数は、投稿から指定したキー(および値)を持つカスタムフィールドをすべて削除します。[[関数リファレンス/update post meta|update_post_meta()]], [[関数リファレンス/get post meta|get_post_meta()]], [[関数リファレンス/add post meta|add_post_meta()]] も見てください。
  
==Usage==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
%%% <?php delete_post_meta($post_id, $key, $value); ?> %%%
+
<?php delete_post_meta( $post_id, $key, $value ); ?>  
  
==Parameters==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$post_id|integer|The ID of the post from which you will delete a field.}}
+
{{Parameter|$post_id|整数|削除したいカスタムフィールドを持つ投稿の ID。}}
{{Parameter|$key|string|The key of the field you will delete.}}
+
{{Parameter|$key|文字列|削除したいカスタムフィールドのキー。}}
{{Parameter|$value|string|The value of the field you will delete. This is used to differentiate between several fields with the same key. If left blank, all fields with the given key will be deleted.|optional}}
+
{{Parameter|$value|string|削除したいカスタムフィールドの値。これは、同じキーを持つカスタムフィールドを区別するパラメータです。省略すると、指定したキーを持つカスタムフィールドはすべて削除されます。|オプション}}
  
==Examples==
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
===Default Usage===
+
<div id="Default_Usage">
 +
===デフォルトの使い方===
 +
</div>
  
  <?php delete_post_meta(76, 'my_key', 'Steve'); ?>
+
  <?php delete_post_meta( 76, 'my_key', 'Steve' ); ?>
  
===Other Examples===
+
===その他の例===
  
Let's assume we had a plugin that added some meta values to posts, but now when we are uninstalling the plugin, we want to delete all the post meta keys that the plugin added. Assuming the plugin added the keys <tt>related_posts</tt> and <tt>post_inspiration</tt>.
+
投稿にカスタムフィールドを追加するプラグインを例に考えます。追加するカスタムフィールドは <tt>related_posts</tt> <tt>post_inspiration</tt> とし、プラグインがアンインストールされるときには、これらのカスタムフィールドを削除するとします。
  
To delete all the keys, this would be added to the "uninstall" function:
+
指定したキーを持つカスタムフィールドをすべて削除するため、以下のコードを ''uninstall'' 関数に追加します:
 
<pre><?php
 
<pre><?php
   $allposts = get_posts('numberposts=0&post_type=post&post_status=');
+
   $allposts = get_posts( 'numberposts=0&post_type=post&post_status=' );
  
   foreach( $allposts as $postinfo) {
+
   foreach( $allposts as $postinfo ) {
     delete_post_meta($postinfo->ID, 'related_posts');
+
     delete_post_meta( $postinfo->ID, 'related_posts' );
     delete_post_meta($postinfo->ID, 'post_inspiration');
+
     delete_post_meta( $postinfo->ID, 'post_inspiration' );
 
   }
 
   }
 
?></pre>
 
?></pre>
  
Or, if you wanted to delete all the keys except where <tt>post_inspiration</tt> was "Sherlock Holmes":
+
キーが <tt>post_inspiration</tt> で値が ''Sherlock Holmes'' 以外のカスタムフィールドを削除する場合:
  
 
<pre><?php
 
<pre><?php
   $allposts = get_posts('numberposts=0&post_type=post&post_status=');
+
   $allposts = get_posts( 'numberposts=0&post_type=post&post_status=') ;
  
   foreach( $allposts as $postinfo) {
+
   foreach( $allposts as $postinfo ) {
 
     delete_post_meta($postinfo->ID, 'related_posts');
 
     delete_post_meta($postinfo->ID, 'related_posts');
 
     $inspiration = get_post_meta( $postinfo->ID, 'post_inspiration );
 
     $inspiration = get_post_meta( $postinfo->ID, 'post_inspiration );
 
     foreach( $inspiration as $value ) {
 
     foreach( $inspiration as $value ) {
 
       if( $value != "Sherlock Holmes" )
 
       if( $value != "Sherlock Holmes" )
         delete_post_meta($postinfo->ID, 'post_inspiration', $value);
+
         delete_post_meta( $postinfo->ID, 'post_inspiration', $value );
 
     }
 
     }
 
   }
 
   }
 
?></pre>
 
?></pre>
  
Or maybe post number 185 was just deleted, and you want to remove all <tt>related_posts</tt> keys that reference it:
+
ID が185の投稿が削除されたので、その投稿を参照している <tt>related_posts</tt> キーを持つカスタムフィールドを削除する場合:
  
 
<pre><?php
 
<pre><?php
   $allposts = get_posts('numberposts=0&post_type=post&post_status=');
+
   $allposts = get_posts( 'numberposts=0&post_type=post&post_status=' );
  
   foreach( $allposts as $postinfo) {
+
   foreach( $allposts as $postinfo ) {
     delete_post_meta($postinfo->ID, 'related_posts', '185');
+
     delete_post_meta( $postinfo->ID, 'related_posts', '185' );
 
   }
 
   }
 
?></pre>
 
?></pre>
For a more detailed example, go to the [[Function Reference/post meta Function Examples|post_meta Functions Examples]] page.
 
  
'''''Note:''' Unlike [[Function Reference/update post meta|update_post_meta()]], This function will delete '''all''' fields that match the criteria.''
+
さらに詳しい例は [[関数リファレンス/post meta 関数の例|post meta 関数の例]] を見てください。
 +
 
 +
'''''注:''' この関数は、条件に一致するすべてのカスタムフィールドを削除します。''
  
==Related==
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
 
{{Post Meta Tags}}
 
{{Post Meta Tags}}

2010年4月22日 (木) 22:16時点における版

この関数は、投稿から指定したキー(および値)を持つカスタムフィールドをすべて削除します。update_post_meta(), get_post_meta(), add_post_meta() も見てください。

使い方

<?php delete_post_meta( $post_id, $key, $value ); ?> 

パラメータ

$post_id
整数) (必須) 削除したいカスタムフィールドを持つ投稿の ID。
初期値: なし
$key
文字列) (必須) 削除したいカスタムフィールドのキー。
初期値: なし
$value
string) (オプション) 削除したいカスタムフィールドの値。これは、同じキーを持つカスタムフィールドを区別するパラメータです。省略すると、指定したキーを持つカスタムフィールドはすべて削除されます。
初期値: なし

用例

デフォルトの使い方

<?php delete_post_meta( 76, 'my_key', 'Steve' ); ?>

その他の例

投稿にカスタムフィールドを追加するプラグインを例に考えます。追加するカスタムフィールドは related_postspost_inspiration とし、プラグインがアンインストールされるときには、これらのカスタムフィールドを削除するとします。

指定したキーを持つカスタムフィールドをすべて削除するため、以下のコードを uninstall 関数に追加します:

<?php
  $allposts = get_posts( 'numberposts=0&post_type=post&post_status=' );

  foreach( $allposts as $postinfo ) {
    delete_post_meta( $postinfo->ID, 'related_posts' );
    delete_post_meta( $postinfo->ID, 'post_inspiration' );
  }
?>

キーが post_inspiration で値が Sherlock Holmes 以外のカスタムフィールドを削除する場合:

<?php
  $allposts = get_posts( 'numberposts=0&post_type=post&post_status=') ;

  foreach( $allposts as $postinfo ) {
    delete_post_meta($postinfo->ID, 'related_posts');
    $inspiration = get_post_meta( $postinfo->ID, 'post_inspiration );
    foreach( $inspiration as $value ) {
      if( $value != "Sherlock Holmes" )
        delete_post_meta( $postinfo->ID, 'post_inspiration', $value );
    }
  }
?>

ID が185の投稿が削除されたので、その投稿を参照している related_posts キーを持つカスタムフィールドを削除する場合:

<?php
  $allposts = get_posts( 'numberposts=0&post_type=post&post_status=' );

  foreach( $allposts as $postinfo ) {
    delete_post_meta( $postinfo->ID, 'related_posts', '185'  );
  }
?>

さらに詳しい例は post meta 関数の例 を見てください。

注: この関数は、条件に一致するすべてのカスタムフィールドを削除します。


カスタムフィールド: the_meta(), get_post_meta(), add_post_meta(), update_post_meta(), delete_post_meta(), get_post_custom(), get_post_custom_values(), get_post_custom_keys() (post_meta 関数の例 /en も参照)


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

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