PHPでは配列を使用してさまざまな処理が可能です。
この記事では、
・array_filter関数で配列をフィルタリングする方法
・array_filter関数で連想配列をフィルタリングする方法
という基本的な内容から、
・array_filter関数で配列のNULL要素を削除する方法
・array_filter関数でflagを指定する方法
・array_map関数を使用する方法
などの応用的な使い方に関しても解説していきます。
今回はそんなarray_filter関数の使用方法について、わかりやすく解説します！
配列の要素をフィルタリングする
ここではarray_filter関数を使用して、配列の要素をフィルタリングする方法を解説します。
array_filter関数を使用する
コールバック関数を使用して、配列の要素をフィルタリングする場合にはarray_filter関数を使用します。
array_filter関数は、第一引数にコールバック関数に渡す配列を指定し、第二引数にコールバック関数を指定します。
第三引数にはコールバック関数に何を送るかflagで指定します。
array_filter( $配列 [, コールバック関数 [, $flag ]] )
戻り値には、コールバック関数でフィルタリングされた結果の配列を返します。
以下にarray_filter関数を指定して、コールバック関数で配列の要素をフィルタリングする方法を記述します。
<?php
function valuecomp($var)
{
// 300以上の配列の値を返す
return($var > 300);
}
$value_array = [100, 200, 300, 400, 500];
//array_filterを使用してコールバック関数に配列を渡す
$value = array_filter($value_array, 'valuecomp');
var_dump($value);
?>
実行結果
array(2) { [3]=> int(400) [4]=> int(500) }
サンプルではコールバック関数で、渡された配列の値が300以上の要素を返しています。
実行結果のとおり、コールバック関数でフィルタリングされた値のみが、配列に格納されていることがわかりますね！
nullの要素を排除する
array_filter関数を使用して、配列のNULLの要素を削除したい場合は以下のように記述します。
<?php
function valuecomp($var)
{
// null以外の値を返す
return($var <> null);
}
$value_array = [100, 200, null, 400, null];
//array_filterを使用してコールバック関数に配列を渡す
$value = array_filter($value_array, 'valuecomp');
var_dump($value);
?>
実行結果
array(3) { [0]=> int(100) [1]=> int(200) [3]=> int(400) }
なお、array_filter関数の引数にstrlen関数を指定することでも、配列のnullや空の要素を簡単に削除することができます。
以下にstrlen関数を使用した、配列のnull要素を削除する方法を記述します。
<?php $value_array = [null, 200, null, 400, null]; //array_filterを使用してstrlen関数に配列を渡す $value = array_filter($value_array, 'strlen'); var_dump($value); ?>
実行結果
array(2) { [1]=> int(200) [3]=> int(400) }
連想配列の要素をフィルタリングする
array_filter関数は、連想配列や多次元配列も1次元配列同様の使い方ができます。
連想配列や多次元配列の場合は、array_filter関数の第三引数を指定しなかった場合、配列の値のみがコールバック関数に渡されます。
以下に連想配列でarray_filterを使用する方法を記述します。
<?php
function valuecomp($var)
{
// 300以上の配列の値を返す
return($var > 300);
}
$value_array = ['A'=>100, 'B'=>200, 'C'=>300, 'D'=>400, 'E'=>500];
//array_filterを使用してコールバック関数に配列を渡す
$value = array_filter($value_array, 'valuecomp');
var_dump($value);
?>
実行結果
array(2) { ["D"]=> int(400) ["E"]=> int(500) }
最初のサンプル同様に連想配列の値も、コールバック関数でフィルタリングされた配列を返していることがわかりますね！
flagを指定する
array_filter関数は、第三引数のflagを指定することで、コールバック関数に配列の何を送るのかを指定することができます。
flagには、以下を指定します。
ARRAY_FILTER_USE_KEY：配列のキーだけをコールバック関数に渡す
ARRAY_FILTER_USE_BOTH：値とキーの両方をコールバック関数に渡す
以下では第三引数にARRAY_FILTER_USE_KEYを指定して、連想配列のキーのみをコールバック関数に渡す方法を記述します。
<?php
function fruitscomp($var)
{
// 2以下の配列のキーを返す
return($var < 2);
}
$fruits = [0=>'apple', 1=>'orange', 2=>'melon', 3=>'banana', 4=>'pineapple'];
//array_filterを使用してコールバック関数に配列を渡す
$fruits_value = array_filter($fruits, 'fruitscomp', ARRAY_FILTER_USE_KEY);
var_dump($fruits_value);
?>
実行結果
array(2) { [0]=> string(5) "apple" [1]=> string(6) "orange" }
サンプルでは、コールバック関数で連想配列のキーのみを渡しています。
実行結果のとおり、キーで比較した結果の配列が返されていることがわかりますね！
配列の要素を全て渡す
配列の要素を全てコールバック関数に渡すには、array_filter関数と同様にコールバック関数に配列を渡すarray_map関数を使用します。
array_map関数については、以下の記事で詳しく解説しています！
array関数についてもっと詳しく知りたい方へ
配列を操作するさまざまな関数の使い方については、以下の記事にまとめていますので、ぜひ参考にしてくださいね！
まとめ
ここでは、array_filter関数を使用して、配列の要素をフィルタリングする基本的な方法から、NULLの要素を削除する方法、flagを指定する方法などについて解説しました。
array_filter関数は、配列を指定した条件でフィルタリングしたいときに非常に便利です。
もし、array_filter関数の使用方法を忘れてしまったら、この記事を思い出してくださいね！
