当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(最新版のマージ)
(クリーンアップ。)
 
3行目: 3行目:
 
</div>
 
</div>
  
この関数は、投稿から指定したキー(もしくはキーと値)を持つカスタムフィールドをすべて削除します。[[関数リファレンス/update post meta|update_post_meta()]], [[関数リファレンス/get post meta|get_post_meta()]], [[関数リファレンス/add post meta|add_post_meta()]] も見てください。
+
この関数は、投稿から指定したキー(もしくはキーと値)を持つカスタムフィールドをすべて削除します。[[関数リファレンス/update post meta|update_post_meta()]][[関数リファレンス/get post meta|get_post_meta()]][[関数リファレンス/add post meta|add_post_meta()]] も見てください。
  
 
<div id="Usage">
 
<div id="Usage">
9行目: 9行目:
 
</div>
 
</div>
  
  <?php delete_post_meta($post_id, $meta_key, $meta_value); ?>
+
  <?php delete_post_meta( $post_id, $meta_key, $meta_value ); ?>
  
 
<div id="Parameters">
 
<div id="Parameters">
17行目: 17行目:
 
{{Parameter|$post_id|整数|削除したいカスタムフィールドを持つ投稿の ID。}}
 
{{Parameter|$post_id|整数|削除したいカスタムフィールドを持つ投稿の ID。}}
 
{{Parameter|$meta_key|文字列|削除したいカスタムフィールドのキー。}}
 
{{Parameter|$meta_key|文字列|削除したいカスタムフィールドのキー。}}
{{Parameter|$meta_value|mixed|削除したいカスタムフィールドの値。これは、同じキーを持つカスタムフィールドを区別するパラメータです。省略すると、指定したキーを持つカスタムフィールドはすべて削除されます。|オプション|''Empty''}}
+
{{Parameter|$meta_value|mixed|削除したいカスタムフィールドの値。これは、同じキーを持つカスタムフィールドを区別するパラメータです。省略すると、指定したキーを持つカスタムフィールドはすべて削除されます。|オプション|<nowiki>''</nowiki>}}
  
<div id="Return values">
+
<div id="Return_values">
==戻り値==
+
== 戻り 値==
 
</div>
 
</div>
  
; (boolean) : 失敗なら False 、成功なら Trueを返す。
+
; (真偽値) : 失敗なら False、成功なら True を返す。
 
+
  
 
<div id="Examples">
 
<div id="Examples">
31行目: 30行目:
  
 
<div id="Default_Usage">
 
<div id="Default_Usage">
===デフォルトの使い方===
+
=== デフォルトの使い方 ===
 
</div>
 
</div>
  
 
  <?php delete_post_meta( 76, 'my_key', 'Steve' ); ?>
 
  <?php delete_post_meta( 76, 'my_key', 'Steve' ); ?>
  
===その他の例===
+
=== その他の例 ===
  
 
投稿にカスタムフィールドを追加するプラグインを例に考えます。追加するカスタムフィールドは <tt>related_posts</tt> と <tt>post_inspiration</tt> とし、プラグインがアンインストールされるときには、これらのカスタムフィールドを削除するとします。
 
投稿にカスタムフィールドを追加するプラグインを例に考えます。追加するカスタムフィールドは <tt>related_posts</tt> と <tt>post_inspiration</tt> とし、プラグインがアンインストールされるときには、これらのカスタムフィールドを削除するとします。
53行目: 52行目:
 
     $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( 'Sherlock Holmes' !== $value )
+
       if ( 'Sherlock Holmes' !== $value )
 
         delete_post_meta( $postinfo->ID, 'post_inspiration', $value );
 
         delete_post_meta( $postinfo->ID, 'post_inspiration', $value );
 
     }
 
     }
59行目: 58行目:
 
?></pre>
 
?></pre>
  
ID が185の投稿が削除されたので、その投稿を参照している <tt>related_posts</tt> キーを持つカスタムフィールドを削除する場合:
+
ID が 185 の投稿が削除されたので、その投稿を参照している <tt>related_posts</tt> キーを持つカスタムフィールドを削除する場合:
  
 
<pre><?php
 
<pre><?php
69行目: 68行目:
 
?></pre>
 
?></pre>
  
さらに詳しい例は [[関数リファレンス/post meta|post meta]] 関数の例を見てください。
+
さらに詳しい例は [[関数リファレンス/post meta 関数の例|post_meta 関数の例]] を見てください。
 
+
'''注:''' Unlike [[関数リファレンス/update post meta|update_post_meta()]], この関数は、条件に一致するすべてのカスタムフィールドを削除します。''
+
  
 +
'''''注:''' [[関数リファレンス/update post meta|update_post_meta()]] 関数とは異なり、この関数は条件に一致するすべてのカスタムフィールドを削除します。''
  
 
== ソースファイル ==
 
== ソースファイル ==
  
<tt>delete_post_meta()</tt> は {{Trac|wp-includes/post.php}}にあります。
+
<tt>delete_post_meta()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
 
<div id="Change Log">
 
<div id="Change Log">
91行目: 89行目:
  
 
{{Tag Footer}}
 
{{Tag Footer}}
{{原文|Function Reference/delete post meta|132522}}<!-- 15:55, 25 June 2013‎ JD55  -->
+
 
 +
{{原文|Function Reference/delete post meta|132522}} <!-- 15:55, 25 June 2013 JD55  -->
 +
 
 +
{{DEFAULTSORT:Delete_post_meta}}
 +
[[Category:関数]]
  
 
[[en:Function Reference/delete post meta]]
 
[[en:Function Reference/delete post meta]]

2015年8月25日 (火) 21:17時点における最新版

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

使い方

<?php delete_post_meta( $post_id, $meta_key, $meta_value ); ?>

パラメータ

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

戻り 値

(真偽値) 
失敗なら False、成功なら True を返す。

用例

デフォルトの使い方

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

その他の例

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

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

<?php delete_post_meta_by_key( 'related_posts' ); ?>

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

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

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

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

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

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

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

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

ソースファイル

delete_post_meta()wp-includes/post.php にあります。

更新履歴

新規導入: 1.5.0


カスタムフィールド: 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最新版との差分