関数・クラス解説

array_filter

version:PHP 4 >= 4.0.6, PHP 5, PHP 7 (公式)

コールバック関数を使用して、配列の要素をフィルタリングする

公式リファレンス

書式

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

説明

callback 関数によりフィルタ処理が行われた array の全ての要素を含む配列を返します。 callback 関数が TRUE を返した場合、 array の現在の値が結果の配列に入ります。

配列のキーは保存されます。 array にインデックスが振られていた場合、結果が異なる場合があります。 結果の array のインデックスは、 array_values() 関数を使って振り直されます。

パラメータ

array
処理する配列。
callback
使用するコールバック関数。 コールバック関数が与えられなかった場合、 array のエントリの中で空のものはすべて削除されます。 この場合の「空」の定義については、empty() 関数を参照して下さい。
flag
引数として、何を callback に送るのかを決めるフラグ。
  • ARRAY_FILTER_USE_KEY - 値ではなく、キーだけを callback の引数として渡す
  • ARRAY_FILTER_USE_BOTH - 値だけではなく、値とキーの両方を callback の引数として渡す
デフォルトは 0 で値のみをcallbackの引数として渡します。

返値

フィルタリングされた結果の配列を返します。

注意

警告 配列の内容がコールバック関数内で変更された場合 (たとえば要素が追加されたり削除されたりなど) のこの関数の挙動は未定義です。

更新履歴

バージョン 説明
5.6.0 オプションのパラメータ flag と、定数 ARRAY_FILTER_USE_KEY および ARRAY_FILTER_USE_BOTH が追加されました。

サンプル

例1 array_filter() の例

function odd($var) {     // 渡された整数が奇数かどうかを返します     return $var & 1; } function even($var) {     // 渡された整数が偶数かどうかを返します     return !($var & 1); } $array1 = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5]; $array2 = [6, 7, 8, 9, 10, 11, 12]; echo "Odd :\n"; print_r(array_filter($array1, "odd")); echo "Even:\n"; print_r(array_filter($array2, "even"));

上の例の出力は以下となります。

Odd : Array ( [a] => 1 [c] => 3 [e] => 5 ) Even: Array ( [0] => 6 [2] => 8 [4] => 10 [6] => 12 )

例2 callback がない array_filter()

$entry = [     0 => 'foo',     1 => false,     2 => -1,     3 => null,     4 => '',     5 => '0',     6 => 0, ]; print_r(array_filter($entry));

上の例の出力は以下となります。

Array ( [0] => foo [2] => -1 )

例3 array_filter() で flag を使う例

$arr = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4]; var_dump(array_filter($arr, function($k) {     return $k == 'b'; }, ARRAY_FILTER_USE_KEY)); var_dump(array_filter($arr, function($v, $k) {     return $k == 'b' || $v == 4; }, ARRAY_FILTER_USE_BOTH));

上の例の出力は以下となります。

array(1) { ["b"]=> int(2) } array(2) { ["b"]=> int(2) ["d"]=> int(4) }

参考

  • array_map() - 指定した配列の要素にコールバック関数を適用する
  • array_reduce() - コールバック関数を用いて配列を普通の値に変更することにより、配列を再帰的に減らす
  • array_walk() - 配列の全ての要素にユーザー定義の関数を適用する
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール