ユーザーメタデータの操作（Working with User Metadata）

はじめに

WordPressのusersテーブルは、ユーザーに関する基本的な情報のみを含むように設計されています。

WP 4.7以降、このテーブルには：ID、user_login、user_pass、user_nicename、user_email、user_url、user_registered、user_activation_key、user_status、display_nameが含まれています。

このため、追加のデータを保存するために、usermetaテーブルが導入され、ユーザーに関する任意の量のデータを保存できます。

両方のテーブルは、usersテーブルのIDに基づく1対多の関係で結びついています。

ユーザーメタデータの操作

ユーザーメタデータを操作する主な方法は2つあります。

• 1. ユーザーのプロフィール画面のフォームフィールド。
• 2. プログラム的に、関数呼び出しを介して。
  

フォームフィールドを介して

フォームフィールドオプションは、ユーザーがWordPress管理エリアにアクセスできる場合に適しています。このエリアでは、プロフィールを表示および編集できます。

例に入る前に、プロセスに関与するフックとその理由を理解することが重要です。

show_user_profileフック

このアクションフックは、ユーザーが自分のユーザープロフィールを編集するたびに発火します。

覚えておいてください、 自分のプロフィールを編集する権限がないユーザーは、このフックを発火させません。

edit_user_profileフック

このアクションフックは、ユーザーが他の誰かのユーザープロフィールを編集するたびに発火します。

覚えておいてください、 第三者のプロフィールを編集する権限がないユーザーは、このフックを発火させません。

例のフォームフィールド

以下の例では、すべてのプロフィール画面に誕生日フィールドを追加します。プロフィールの更新時にデータベースに保存します。

/**
 * The field on the editing screens.
 *
 * @param $user WP_User user object
 */
function wporg_usermeta_form_field_birthday( $user ) {
   ?>
   <h3>It's Your Birthday</h3>
   <table class="form-table">
   <tr>
   <th>
   <label for="birthday">Birthday</label>
   </th>
   <td>
   <input type="date"
   class="regular-text ltr"
   id="birthday"
   name="birthday"
   value="<?= esc_attr( get_user_meta( $user->ID, 'birthday', true ) ) ?>"
   title="Please use YYYY-MM-DD as the date format."
   pattern="(19[0-9][0-9]|20[0-9][0-9])-(1[0-2]|0[1-9])-(3[01]|[21][0-9]|0[1-9])"
   required>
   <p class="description">
   Please enter your birthday date.
   </p>
   </td>
   </tr>
   </table>
   <?php
}
/**
 * The save action.
 *
 * @param $user_id int the ID of the current user.
 *
 * @return bool Meta ID if the key didn't exist, true on successful update, false on failure.
 */
function wporg_usermeta_form_field_birthday_update( $user_id ) {
   // check that the current user have the capability to edit the $user_id
   if ( ! current_user_can( 'edit_user', $user_id ) ) {
   return false;
   }
   // create/update user meta for the $user_id
   return update_user_meta(
   $user_id,
   'birthday',
   $_POST['birthday']
   );
}
// Add the field to user's own profile editing screen.
add_action(
   'show_user_profile',
   'wporg_usermeta_form_field_birthday'
);
// Add the field to user profile editing screen.
add_action(
   'edit_user_profile',
   'wporg_usermeta_form_field_birthday'
);
// Add the save action to user's own profile editing screen update.
add_action(
   'personal_options_update',
   'wporg_usermeta_form_field_birthday_update'
);
// Add the save action to user profile editing screen update.
add_action(
   'edit_user_profile_update',
   'wporg_usermeta_form_field_birthday_update'
);

プログラム的に

このオプションは、カスタムユーザーエリアを構築している場合や、WordPress管理エリアへのアクセスを無効にする予定がある場合に適しています。

ユーザーメタデータを操作するために利用可能な関数は：add_user_meta()、update_user_meta()、delete_user_meta()、get_user_meta()です。

追加

add_user_meta(
   int $user_id,
   string $meta_key,
   mixed $meta_value,
   bool $unique = false
);

使用されるパラメータの完全な説明については、add_user_meta()に関する関数リファレンスを参照してください。

更新

update_user_meta(
   int $user_id,
   string $meta_key,
   mixed $meta_value,
   mixed $prev_value = ''
);

使用されるパラメータの完全な説明については、update_user_meta()に関する関数リファレンスを参照してください。

削除

delete_user_meta(
   int $user_id,
   string $meta_key,
   mixed $meta_value = ''
);

使用されるパラメータの完全な説明については、delete_user_meta()に関する関数リファレンスを参照してください。

取得

get_user_meta(
   int $user_id,
   string $key = '',
   bool $single = false
);

使用されるパラメータの完全な説明については、get_user_meta()に関する関数リファレンスを参照してください。

注意してください、$user_idのみを渡すと、関数はすべてのメタデータを連想配列として取得します。

プラグインやテーマのどこでもユーザーメタデータをレンダリングできます。