[PHP] array_filter関数を使ってサンプルを作ってみる



Nプログラマです。

今回は、PHPのarray_filter関数を使ってサンプルを作ってみました。

array_filter関数とは?

配列に入っている要素をフィルタリングする関数です。 フィルタリングする方法はコールバック関数で指定します。

例えば、1から10が入っている配列から、偶数だけ取り除いた奇数だけの新しい配列を取得できたりします。

新しい配列を生成して返すので、元の配列には影響がありません。

マニュアルを見てみる

array_filter(array $array [, callable $callback [, int $flag = 0 ]]) : array

v5.6.0からflagを指定することができるようになりました。

これを使うと、コールバックの引数の受け取り方を指定することができます。
サンプルでも作って試しています。

サンプル1: リンゴだけを取り出す

フルーツの情報が入った配列から、リンゴだけを取り出すサンプルを作ってみます。

コード

サンプル1 コードを開く
サンプル1

<?php

// 引数がappleならtrueを返す
function is_apple($fruit)
{
    return ($fruit == 'apple');
}

$fruits = ['apple', 'banana', 'orange'];
$result = array_filter($fruits, 'is_apple');

// フィルタする前
print_r($fruits);
// フィルタした後
print_r($result);

結果

サンプル1の結果 を開く
サンプル1の結果

// フィルタ前
Array
 (
     [0] => apple
     [1] => banana
     [2] => orange
 )
// フィルタ後
 Array
 (
     [0] => apple
 )

$fruitsappleだけをフィルタした結果を確認することができました。

is_apple関数を定義せず、無名関数を渡しても同じ結果が得られます。

サンプル2: コールバック関数の引数に、配列のvalueとkeyを受け取るようにしてみる

先程のサンプルでは、コールバック関数の引数が配列のvalueだけでした。

array_filterの第三引数のflagを使えば、配列のvalueとkeyの両方を渡すことができたりします。

表にするとこんな感じです。

第三引数の指定 どうなるか?
なし 配列のvalueをコールバックの引数に渡す
ARRAY_FILTER_USE_KEY 配列のkeyをコールバックの引数に渡す
ARRAY_FILTER_USE_BOTH 配列のvalueとkeyをコールバックの引数に渡す

連想配列で特定のkey名や、valueでフィルタしたいという時に使えそうです。

コールバックの引数の順序について

flagでARRAY_FILTER_USE_BOTHを指定した時、コールバックが受け付ける引数の順序はvalue、keyの順序であることに注意です。
(key, valueではありません)

これを使って、以下の条件で配列をフィルタリングをするサンプルを作ってみます。

  • key名がfirst_personを除外
  • valueのageが40なら除外

コード

サンプル2 コードを開く
サンプル2

<?php

// array_filterに渡すコールバック関数
function person_filter($value, $key)
{
    // key名がfirst_personを除外
    if ($key == 'first_person') {
        return false;
    }

    // ageが40を除外
    if ($value['age'] == 40) {
        return false;
    }

    // それ以外は除外しない
    return true;
}

// personが入った配列
$persons = [
    // さいしょの人
    'first_person' => [
        'name' => 'さいしょの人の名前',
        'age'  => 20,
        'job'  => '戦士'
    ],
    // にばんめの人
    'second_person' => [
        'name' => 'にばんめの人の名前',
        'age'  => 30,
        'job'  => '魔法使い'
    ],
    // さいごの人
    'last_person' => [
        'name' => 'さいごの人の名前',
        'age'  => 40,
        'job'  => '僧侶'
    ]
];

// フィルタリング (第三引数で、ARRAY_FILTER_USE_BOTHを指定)
$result = array_filter($persons, 'person_filter', ARRAY_FILTER_USE_BOTH);
print_r($persons);  // フィルタ前
print_r($result);   // フィルタ後

結果

サンプル2の結果 を開く
サンプル2の結果

Array
(
    [first_person] => Array
        (
            [name] => さいしょの人の名前
            [age] => 20
            [job] => 戦士
        )

    [second_person] => Array
        (
            [name] => にばんめの人の名前
            [age] => 30
            [job] => 魔法使い
        )

    [last_person] => Array
        (
            [name] => さいごの人の名前
            [age] => 40
            [job] => 僧侶
        )

)
Array
(
    [second_person] => Array
        (
            [name] => にばんめの人の名前
            [age] => 30
            [job] => 魔法使い
        )

)

今回はにばんめの魔法使いがフィルタされるという結果になりました。

こんな感じでvalueとkeyをコールバックの引数に渡せることも覚えておくと役に立つかもしれないですね。

おわりに

今回は、array_filter関数のサンプルを作ってみるという内容でした。

第三引数のflagの使い方は、最近知ったので勉強になりました。
ちょっとフィルタ条件が多い時に使えるかもしれないですね。

それでは、このへんで。
バイナリー!



関連した記事