概要
wp_unique_prefixed_id関数は、プレフィックスごとにユニークなIDを生成するための関数です。この関数は、データベースのテーブルやカスタムオブジェクトの識別子を作成する際に特に便利です。具体的には、以下のような機能を実装する際に役立ちます。
- カスタム投稿タイプのスラッグを生成
- 一意のユーザーIDの生成
- プラグインの設定オプションにユニークなキーを作成
- テーマやプラグインに関連する設定の一意の識別子を生成
- フォームのフィールド名をユニークに保つ
- 一意のトランザクションIDの生成
- セッション管理のためのユニークな識別子生成
- 外部APIとの通信におけるリクエストIDの生成
構文
string wp_unique_prefixed_id( string $prefix );
パラメータ
$prefix(string): ユニークIDに追加されるプレフィックス。任意の文字列を指定可能です。
戻り値
- (string): 指定したプレフィックスを持つユニークなID。
関連する関数
バージョン
この関数はWordPressのコアファイルの一部であり、バージョン5.0以降で使用可能です。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 | 〇 |
サンプルコード
サンプルコード 1: プレフィックス付きのユニークID生成
$unique_id = wp_unique_prefixed_id('order_');
echo $unique_id; // 出力例: order_5fbb2c2dcb829
このコードは、「order_」というプレフィックスを持つユニークIDを生成し、出力します。
サンプルコード 2: ユーザーIDの生成
function generate_user_id() {
return wp_unique_prefixed_id('user_');
}
$user_id = generate_user_id();
echo $user_id; // 出力例: user_7f99b2c24541d
この関数は、ユーザー用のユニークIDを生成し、そのIDを返します。
サンプルコード 3: 一意の設定キーを生成
$options_key = 'custom_option_' . wp_unique_prefixed_id('');
update_option($options_key, 'some_value');
この例では、ユニークな設定キーを生成し、そのキーでオプションを更新します。
サンプルコード 4: フォームフィールド名の生成
$input_name = 'input_' . wp_unique_prefixed_id('');
echo '<input type="text" name="' . esc_attr($input_name) . '">';
このコードは、ユニークなフィールド名を持つテキストインプットを生成します。
サンプルコード 5: トランザクションIDの生成
$transaction_id = wp_unique_prefixed_id('txn_');
process_transaction($transaction_id);
このコードでは、トランザクション用のユニークIDを生成し、処理関数に渡します。