概要
wp_rand関数は、WordPressで乱数を生成するための専用関数です。この関数は、主に以下のような機能を実装する際に利用されます。
- セキュアなトークンの生成
- ユーザーのランダムなIDの作成
- ランダムな投稿やページの表示
- カスタムクエリでのランダムな結果の取得
- ゲームやクイズでの乱数選出
- スライドショーやギャラリー内のランダム画像表示
- テストデータの生成
- ワードプレスのカスタムウィジェットにおけるランダムな表示内容
構文
wp_rand( $min = 0, $max = 0 );
パラメータ
$min(整数): 生成する乱数の最小値。省略した場合は0。$max(整数): 生成する乱数の最大値。省略した場合は0。
戻り値
- 生成された乱数 (整数)
関連する関数
使用可能なバージョン
wp_rand関数は、WordPress 2.0以降で使用可能です。
コアファイルのパス
wp-includes/functions.php
サンプルコード
サンプルコード1: 0から100までの乱数を生成
$random_number = wp_rand(0, 100);
echo $random_number; // 0から100の範囲で乱数を出力
このコードは、0から100までの範囲でランダムな整数を生成し、それを出力しています。
サンプルコード2: ユーザーのランダムIDを生成
$user_id = wp_rand(1, 1000);
echo "ランダムユーザーID: " . $user_id; // 1から1000の間のユーザーIDを表示
このコードは、1から1000の範囲でランダムなユーザーIDを生成し、表示しています。
サンプルコード3: ランダムな投稿取得の例
$args = array(
'posts_per_page' => 1,
'orderby' => 'rand'
);
$random_post_query = new WP_Query($args);
このコードは、ランダムな1件の投稿を取得するためのクエリを実行しています。
サンプルコード4: ボタンをクリックしたときに乱数を生成
if (isset($_POST['generate'])) {
$random_number = wp_rand(10, 50);
echo $random_number; // 10から50の間で乱数を出力
}
このコードは、ボタンがクリックされたときに10から50の乱数を生成し、それを出力します。
サンプルコード5: 決定的な乱数生成
$seed = time(); // 現在の時刻をシードとする
$random_number = wp_rand(1, 100);
echo "決定的な乱数: " . $random_number; // 乱数を出力
このコードは、現在の時刻をシードに基づいて1から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 | 〇 |
非推奨または削除されたバージョン
wp_rand関数は、特定のバージョンで非推奨または削除されてはいません。