Search code examples
phparrayskeyfilteringwhitelist

How to filter an associative array comparing keys with values in an indexed array?


The callback function in array_filter() only passes in the array's values, not the keys.

If I have:

$my_array = array("foo" => 1, "hello" => "world");

$allowed = array("foo", "bar");

What's the best way to delete all keys in $my_array that are not in the $allowed array?

Desired output:

$my_array = array("foo" => 1);

Solution

  • PHP 5.6 introduced a third parameter to array_filter(), flag, that you can set to ARRAY_FILTER_USE_KEY to filter by key instead of value:

    $my_array = ['foo' => 1, 'hello' => 'world'];
    $allowed  = ['foo', 'bar'];
    $filtered = array_filter(
        $my_array,
        function ($key) use ($allowed) {
            // N.b. in_array() is notorious for being slow 
            return in_array($key, $allowed);
        },
        ARRAY_FILTER_USE_KEY
    );
    

    Since PHP 7.4 introduced arrow functions we can make this more succinct:

    $my_array = ['foo' => 1, 'hello' => 'world'];
    $allowed  = ['foo', 'bar'];
    $filtered = array_filter(
        $my_array,
        fn ($key) => in_array($key, $allowed),
        ARRAY_FILTER_USE_KEY
    );
    

    Clearly this isn't as elegant as array_intersect_key($my_array, array_flip($allowed)), but it does offer the additional flexibility of performing an arbitrary test against the key, e.g. $allowed could contain regex patterns instead of plain strings.

    You can also use ARRAY_FILTER_USE_BOTH to have both the value and the key passed to your filter function. Here's a contrived example based upon the first, but note that I'd not recommend encoding filtering rules using $allowed this way:

    $my_array = ['foo' => 1, 'bar' => 'baz', 'hello' => 'wld'];
    $allowed  = ['foo' => true, 'bar' => true, 'hello' => 'world'];
    $filtered = array_filter(
        $my_array,
        fn ($val, $key) => isset($allowed[$key]) && (
            $allowed[$key] === true || $allowed[$key] === $val
        ),
        ARRAY_FILTER_USE_BOTH
    ); // ['foo' => 1, 'bar' => 'baz']