【PHP8.x】array_search関数の使い方

Copy
1<?php
2
3/**
4 * array_search 関数の基本的な使い方を示すサンプルコードです。
5 * キーワード「複数」を考慮し、同じ値が配列に複数存在する場合でも
6 * array_search が最初に見つかったキーのみを返す挙動を実演します。
7 */
8function demonstrateArraySearchMultipleOccurrences(): void
9{
10    // 検索対象の配列。'apple' が複数回出現します。
11    $fruits = ['apple', 'banana', 'orange', 'apple', 'grape', 'apple'];
12    $searchValue = 'apple';
13
14    // array_search は、配列内で検索値が見つかった場合、その最初のキーを返します。
15    // ここでは 'apple' が複数回出現しますが、関数はインデックス 0 を返します。
16    $firstOccurrenceKey = array_search($searchValue, $fruits);
17
18    if ($firstOccurrenceKey !== false) {
19        echo "値 '{$searchValue}' は配列のキー {$firstOccurrenceKey} で最初に見つかりました。\n";
20    } else {
21        echo "値 '{$searchValue}' は配列に見つかりませんでした。\n";
22    }
23
24    echo "----------------------------------------\n";
25
26    // array_search の厳密な比較 (strict) モードの例。
27    // このモードでは、値だけでなく型も一致する必要があります。
28    $mixedValues = [1, '2', 3, '1', 1.0];
29    $searchStrictValue = 1; // 整数型 1 を検索
30
31    // strict パラメータを true に設定すると、型も比較されます (===)。
32    // この場合、インデックス 0 の '1' (整数) が一致し、インデックス 3 の '1' (文字列) や
33    // インデックス 4 の 1.0 (浮動小数点数) は型が異なるため一致しません。
34    $strictKey = array_search($searchStrictValue, $mixedValues, true);
35
36    if ($strictKey !== false) {
37        echo "厳密な比較で値 '{$searchStrictValue}' (型: " . gettype($searchStrictValue) . ") は配列のキー {$strictKey} で最初に見つかりました。\n";
38    } else {
39        echo "厳密な比較で値 '{$searchStrictValue}' (型: " . gettype($searchStrictValue) . ") は配列に見つかりませんでした。\n";
40    }
41}
42
43// サンプル関数の実行
44demonstrateArraySearchMultipleOccurrences();
45

PHPのarray_search関数は、配列の中から指定した値を探し、最初に見つかったキー（インデックス番号または連想配列の文字列キー）を返す関数です。

第一引数$needleには検索したい値を、第二引数$haystackには検索対象となる配列を指定します。第三引数$strictはオプションで、trueに設定すると値だけでなくデータ型も厳密に比較します。この引数を省略した場合（デフォルトfalse）、PHPは値を比較する際に必要に応じて型を変換します。

array_searchは、検索値が配列内に複数存在する場合でも、最初に見つかった値のキーのみを返します。例えば、同じ値が配列の異なる位置に複数ある場合でも、関数は一番初めに見つかったその位置のキーのみを報告します。

検索値が見つかった場合はそのキー（整数または文字列）を、見つからなかった場合はfalseを返します。戻り値が0などの有効なキーである可能性もあるため、結果を確認する際はif ($result !== false)のように厳密な比較を用いることが重要です。

strictモードをtrueにすると、値と型が完全に一致する場合にのみ見つかったと判断します。例えば、整数1と文字列'1'は値は同じでも型が異なるため、strictモードでは別物として扱われます。これにより、型変換による意図しない結果を防ぎ、より正確な検索が可能になります。

Copy
1<?php
2
3/**
4 * 連想配列から特定の値を検索し、そのキーを特定するサンプルコードです。
5 * array_search関数は、指定した値が配列内に存在するかどうかを調べ、
6 * 見つかった場合はその要素のキーを返します。見つからない場合はfalseを返します。
7 */
8
9/**
10 * array_search_associative_array_example 関数
11 *
12 * 連想配列に対して array_search() 関数を使用する例を示します。
13 */
14function array_search_associative_array_example(): void
15{
16    // 検索対象となる連想配列を定義します。
17    // キーは文字列、値も文字列です。
18    $users = [
19        'john_doe' => 'John Doe',
20        'jane_smith' => 'Jane Smith',
21        'peter_jones' => 'Peter Jones',
22        'alice_williams' => 'Alice Williams',
23        'guest_user' => '123', // 値が数値のように見えるが、型は文字列
24    ];
25
26    echo "--- 存在する値の検索 (デフォルトモード: 非厳密) ---\n";
27
28    // 存在する値 'Jane Smith' を検索します。
29    // array_search($needle, $haystack, $strict = false)
30    // 第3引数を省略した場合、非厳密モード (false) となり、値の比較時に型を考慮しません。
31    $searchTerm1 = 'Jane Smith';
32    $key1 = array_search($searchTerm1, $users);
33
34    // 検索結果がfalseではないことを確認します。
35    // array_searchは、見つからない場合にfalseを返すため、厳密な比較 (=== false または !== false) を推奨します。
36    if ($key1 !== false) {
37        echo "値 '{$searchTerm1}' はキー '{$key1}' で見つかりました。\n";
38    } else {
39        echo "値 '{$searchTerm1}' は見つかりませんでした。\n";
40    }
41
42    echo "\n--- 存在しない値の検索 (デフォルトモード: 非厳密) ---\n";
43
44    // 存在しない値 'Mike Davis' を検索します。
45    $searchTerm2 = 'Mike Davis';
46    $key2 = array_search($searchTerm2, $users);
47
48    if ($key2 !== false) {
49        echo "値 '{$searchTerm2}' はキー '{$key2}' で見つかりました。\n";
50    } else {
51        echo "値 '{$searchTerm2}' は見つかりませんでした。\n";
52    }
53
54    echo "\n--- 厳密モードでの検索 (型も比較) ---\n";
55
56    // 値が文字列 '123' のエントリが存在します。
57    // 検索値として数値の 123 を使用してみます。
58
59    // 非厳密モードの場合 (strict = false):
60    // PHPは自動的に型変換を試みるため、文字列 '123' と数値 123 は同じと見なされます。
61    $searchTerm3 = 123; // 数値型
62    $key3_nonStrict = array_search($searchTerm3, $users, false); // 第3引数を明示的にfalseに指定
63
64    if ($key3_nonStrict !== false) {
65        echo "非厳密モード: 値 '{$searchTerm3}' (数値) はキー '{$key3_nonStrict}' で見つかりました。\n";
66    } else {
67        echo "非厳密モード: 値 '{$searchTerm3}' (数値) は見つかりませんでした。\n";
68    }
69
70    // 厳密モードの場合 (strict = true):
71    // 値と型の両方が一致する場合にのみ見つかります。
72    // '123' (文字列) と 123 (数値) は型が異なるため、一致しません。
73    $searchTerm4 = 123; // 数値型
74    $key4_strict = array_search($searchTerm4, $users, true); // 第3引数をtrueに指定
75
76    if ($key4_strict !== false) {
77        echo "厳密モード: 値 '{$searchTerm4}' (数値) はキー '{$key4_strict}' で見つかりました。\n";
78    } else {
79        echo "厳密モード: 値 '{$searchTerm4}' (数値) は見つかりませんでした。\n";
80    }
81
82    // 厳密モードで文字列 '123' を検索する場合
83    $searchTerm5 = '123'; // 文字列型
84    $key5_strict = array_search($searchTerm5, $users, true);
85
86    if ($key5_strict !== false) {
87        echo "厳密モード: 値 '{$searchTerm5}' (文字列) はキー '{$key5_strict}' で見つかりました。\n";
88    } else {
89        echo "厳密モード: 値 '{$searchTerm5}' (文字列) は見つかりませんでした。\n";
90    }
91}
92
93// 関数を実行します。
94array_search_associative_array_example();

PHPのarray_search関数は、配列の中から特定の値を検索し、その値に対応するキー（添字）を見つける際に使用します。

この関数は3つの引数を取ります。最初の$needleは検索したい値、次の$haystackは検索対象となる配列です。最後の$strictはオプションの引数で、デフォルトはfalseです。$strictがfalseの場合、値の比較時に型を考慮しません。trueに設定すると、値と型の両方が一致する場合にのみ見つけます。値が見つかるとそのキー（添字）を返し、見つからなかった場合はfalseを返します。このfalseという戻り値は、他の有効なキー（0など）と区別するために、厳密な比較（!== false）で確認することが推奨されます。

サンプルコードでは、ユーザー名と対応する表示名を持つ連想配列$usersを用いています。例えば、存在する値'Jane Smith'を検索すると、そのキー'jane_smith'が返されます。存在しない値'Mike Davis'を検索した場合はfalseが返されます。

特に$strict引数は重要で、例えば文字列'123'と数値123のように、値は同じでも型が異なる場合を区別できます。デフォルトの非厳密モードではこれらを同じと見なしますが、厳密モード（$strict = true）では型が異なるため一致しないと判断され、より正確な検索が可能です。これにより、意図しないマッチングを防ぐことができます。