wp_register_persisted_preferences_meta()


WordPressのwp_register_persisted_preferences_meta()関数は、ユーザーの設定やプリファレンスをデータベースに永続化するためのメタデータを登録するために使用されます。この関数は、ユーザー固有の設定を保存し、後で再利用する際に役立ちます。

構文

wp_register_persisted_preferences_meta( string $meta_key, array $args = array() );

引数の説明:

  • $meta_key(string) — メタデータのキーを指定します。このキーは一意である必要があります。
  • $args(array) — メタデータの追加設定を指定します。以下のオプションを含むことができます:
    • 'type'(string) — メタデータのタイプ（例: ‘string’, ‘integer’）。
    • 'description'(string) — メタデータの説明。
    • 'default'(mixed) — メタデータのデフォルト値。

例1: 基本的なメタデータの登録

ユーザーのテーマ設定を保存するためのメタデータを登録します。

wp_register_persisted_preferences_meta( 'theme_preferences', array( 'type' => 'string', 'description' => 'ユーザーのテーマ設定', 'default' => 'light' ) );

例2: デフォルト値付きのメタデータ登録

デフォルト値を持つメタデータを登録します。

wp_register_persisted_preferences_meta( 'font_size', array( 'type' => 'integer', 'description' => 'フォントサイズ', 'default' => 14 ) );

例3: 複数の設定を一度に登録

複数のメタデータを一度に登録します。

wp_register_persisted_preferences_meta( 'user_settings', array( 'type' => 'array', 'description' => 'ユーザー設定', 'default' => array( 'theme' => 'dark', 'font' => 'Arial' ) ) );

例4: メタデータの更新

登録されたメタデータを更新します。

update_user_meta( get_current_user_id(), 'theme_preferences', 'dark' );

例5: メタデータの取得

登録されたメタデータを取得します。

get_user_meta( get_current_user_id(), 'theme_preferences', true );

例6: メタデータの削除

登録されたメタデータを削除します。

delete_user_meta( get_current_user_id(), 'theme_preferences' );

例7: メタデータの存在確認

メタデータが存在するか確認します。

metadata_exists( 'user', get_current_user_id(), 'theme_preferences' );

注意点

  • メタデータのキーは一意である必要があります。重複すると予期しない動作が発生する可能性があります。
  • メタデータのタイプを正しく指定しないと、データの整合性が損なわれる可能性があります。
  • ユーザーデータを扱う際は、セキュリティに注意してください。

関連機能：