概要
update_post_meta
関数は、カスタムフィールド情報を更新するために使用されます。WordPressの投稿やページに関連するメタデータ(カスタムフィールド)を管理する際に非常に便利です。この関数は以下の8つの機能を実装する際によく使われます。
- 投稿に特定のメタデータを追加する
- 投稿のカスタムフィールドを更新する
- プラグインの設定情報を投稿に保存する
- ウェブサイトのユーザーインターフェース向けにデータを格納する
- 投稿タイプに固有のデータを保存する
- 投稿のセッション情報を管理する
- ジオロケーションデータやカスタム統計を追加する
- サードパーティAPIからのデータを関連付ける
構文
update_post_meta( int $post_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )
パラメータ
- $post_id (int): 更新する投稿のID。
- $meta_key (string): 更新するメタデータのキー。
- $meta_value (mixed): 保存するメタデータの値。
- $prev_value (mixed): オプション。以前の値を指定して一致するメタデータのみを更新する。
戻り値
- 成功した場合は
true
を返し、失敗した場合はfalse
を返す。
関連する関数
使用可能なバージョン
- こちらの関数はWordPress 2.9.0以降で使用可能です。
コアファイルのパス
wp-includes/post.php
サンプルコード
-
カスタムフィールドの追加
update_post_meta( 123, 'favorite_color', 'blue' );
このコードは、投稿ID 123に「favorite_color」というカスタムフィールドを追加し、その値を「blue」に設定します。
-
カスタムフィールドの更新
update_post_meta( 123, 'favorite_color', 'red' );
これは、投稿ID 123の「favorite_color」カスタムフィールドの値を「red」に更新します。
-
カスタムフィールドの特定の値を持つ場合の更新
update_post_meta( 123, 'favorite_color', 'green', 'blue' );
このコードは、投稿ID 123の「favorite_color」カスタムフィールドの値が「blue」である場合にのみ、その値を「green」に更新します。
-
配列としてメタデータを保存
update_post_meta( 123, 'settings', array( 'theme' => 'dark', 'layout' => 'grid' ) );
このコードは、投稿ID 123に対して「settings」というカスタムフィールドを追加し、配列としてデータを保存します。
-
数値としてメタデータを保存
update_post_meta( 123, 'views', 100 );
このサンプルコードは、投稿ID 123の「views」というカスタムフィールドに数値100を保存します。
この関数のアクションでの使用可能性
アクション | 使用例 |
---|---|
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バージョンで非推奨又は削除された場合はありません。