【PHP】in_arrayとは【配列に含まれてるかを確認】

PHPのin_arrayについて説明します。

Contents

in_arrayとは？
- 特定の値が配列に含まれてるかを確認
使い方
参照
- 独習PHP
- 公式
PHPを効率的に学習したい場合
- スクールを活用するのも有効

in_arrayとは？

特定の値が配列に含まれてるかを確認

in_arrayとは、特定の値が配列に含まれてるかを確認する関数のこと。

分類：関数 > 配列関数

配列にこの要素が含まれてるか確認したい！ってときに使う。

使い方

書式

in_array ( mixed $needle , array $haystack [, bool $strict = FALSE ] ) : bool

引数

$needle(必須)：検索文字列。配列に含まれてるか探したい値。
$haystack(必須)：検索対象の配列。
$strict(任意)：型チェックしたい場合はTRUE, 不要な場合はFALSEを指定することができる。デフォルトはFALSE。

戻り値：bool型

配列に指定したneedleで指定した値が含まれていればtrue
配列に指定したneedleで指定した値が含まれていなければfalse

一例

<?php
$characters = ['アーデン', 
               'アラネア', 
               'ルナフレーナ', 
               'ノクティス',
               'ソル',
               'レイヴス'];
$numbers = [0, 1, 2, 3, 5, 8, 13];

echo '■ 含まれるケース / 含まれないケース(文字列)', PHP_EOL;
echo in_array('アーデン', $characters), PHP_EOL;    // true(1)
echo in_array('エイラ', $characters), PHP_EOL;  // false()

echo '■ 含まれるケース / 含まれないケース(数値)', PHP_EOL;
echo in_array(0, $numbers), PHP_EOL;    // true(1)
echo in_array(999, $numbers), PHP_EOL;  // false()

echo '■ 暗黙の型変換によりtrue(1)を返す', PHP_EOL;
echo in_array('アーデン', $numbers), PHP_EOL;    // true(1)

echo '■ 試しに文字列をint型にキャスト', PHP_EOL;
echo (int)$characters[0], PHP_EOL;

echo '■ 第三引数で型チェックTRUEにすれば想定通り', PHP_EOL;
echo in_array('アーデン', $numbers, TRUE);  // false()

<?php

$characters = ['アーデン',

'アラネア',

'ルナフレーナ',

'ノクティス',

'ソル',

'レイヴス'];

$numbers = [0, 1, 2, 3, 5, 8, 13];

echo '■ 含まれるケース / 含まれないケース(文字列)', PHP_EOL;

echo in_array('アーデン', $characters), PHP_EOL; // true(1)

echo in_array('エイラ', $characters), PHP_EOL; // false()

echo '■ 含まれるケース / 含まれないケース(数値)', PHP_EOL;

echo in_array(0, $numbers), PHP_EOL; // true(1)

echo in_array(999, $numbers), PHP_EOL; // false()

echo '■ 暗黙の型変換によりtrue(1)を返す', PHP_EOL;

echo in_array('アーデン', $numbers), PHP_EOL; // true(1)

echo '■ 試しに文字列をint型にキャスト', PHP_EOL;

echo (int)$characters[0], PHP_EOL;

echo '■ 第三引数で型チェックTRUEにすれば想定通り', PHP_EOL;

echo in_array('アーデン', $numbers, TRUE); // false()

実行結果

■ 含まれるケース / 含まれないケース(文字列)
1

■ 含まれるケース / 含まれないケース(数値)
1

■ 暗黙の型変換によりtrue(1)を返す
1
■ 試しに文字列をint型にキャスト
0
■ 第三引数で型チェックTRUEにすれば想定通り

■ 含まれるケース / 含まれないケース(文字列)

■ 含まれるケース / 含まれないケース(数値)

■ 暗黙の型変換によりtrue(1)を返す

■ 試しに文字列をint型にキャスト

■ 第三引数で型チェックTRUEにすれば想定通り

実行結果から解ること

■基本

第一引数が第二引数の要素に含まれていればtrueを返す。

含まれていなければfalseを返す。

■型を意識すること

文字列と数値を比較する際には注意が必要。

暗黙の型変換の関係で、気付かぬ内に文字列が0で比較されている可能性がある。

上記の例の場合、実際に’アーデン’という文字列はnumbers配列に含まれていないが、in_array(‘アーデン’, numbers)の評価結果はtrue(1)。characters[0]が0として評価され、実質、in_array(0, numbers)として評価されている為にtrue(1)が返された。

型込みで比較したい場合は、第三引数にTRUEを指定すること。

第三引数を指定しない場合はFALSEとして振る舞う。

用途例

エラーハンドリング時

一例として、エラーハンドリング時などに使える。

入っている筈の要素が入っているかの判別をし、入っている場合と入っていない場合に処理を分岐させる。

一意となる配列の作成

私が実際に実務で使ったケースとして「既に存在する配列から、一意となる値のみの配列の作り直し」があった。

文字だけだと解りづらいので実例としては、下記のような要領。

<?php
$characters = ['アーデン', 
               'アラネア', 
               'アラネア', 
               'アラネア', 
               'ルナフレーナ', 
               'ルナフレーナ', 
               'ノクティス',
               'ノクティス',
               'ノクティス',
               'ノクティス',
               'ノクティス',
               'ノクティス',
               'ソル',
               'レイヴス',
               'レイヴス'];

$uniqueCharacters = array();
foreach ($characters as $character) {
    if (!in_array($character, $uniqueCharacters)) {
        array_push($uniqueCharacters, $character);
    }
}
var_dump($uniqueCharacters);

<?php

$characters = ['アーデン',

'アラネア',

'ルナフレーナ',

'ノクティス',

'ソル',

'レイヴス',

'レイヴス'];

$uniqueCharacters = array();

foreach ($characters as $character) {

if (!in_array($character, $uniqueCharacters)) {

array_push($uniqueCharacters, $character);

}

var_dump($uniqueCharacters);

array(6) {
  [0]=>
  string(12) "アーデン"
  [1]=>
  string(12) "アラネア"
  [2]=>
  string(18) "ルナフレーナ"
  [3]=>
  string(15) "ノクティス"
  [4]=>
  string(6) "ソル"
  [5]=>
  string(12) "レイヴス"
}