PHP：如何使用 array_filter() 过滤数组键？

Posted 2023-02-14

技术标签:

【中文标题】PHP：如何使用 array_filter() 过滤数组键？【英文标题】：Filter array by its keys using an array of allowed keys 【发布时间】：2011-05-14 16:34:06 【问题描述】：

array_filter() 中的回调函数只传入数组的值，而不是键。

如果我有：

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

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

删除$my_array 中所有不在$allowed 数组中的键的最佳方法是什么？

期望的输出：

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

【问题讨论】：

不是解决方案，但另一种可能有用的方法是$b = ['foo' => $a['foo'], 'bar' => $a['bar']] 这将导致$b['bar'] 成为null。 【参考方案1】：

要达到相反的效果 - 删除数组键。

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

期望的输出：

$my_array = array("hello" => "world");

运行：

$my_array = array_diff_key($my_array, array_flip($not_allowed));

也适用于数字索引数组 - 字符串和整数。

【讨论】：

【参考方案2】：

基于@sepiariver，我在 php 8.0.3 上做了一些类似的测试：

$arr = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => 7, 'h' => 8];
$filter = ['a', 'e', 'h'];


$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) 
  $filtered = array_intersect_key($arr, array_flip($filter));
  $i--;

print_r($filtered);
echo microtime(true) - $time . " using array_intersect_key\n\n";


$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) 
  $filtered = array_filter(
    $arr,
    function ($key) use ($filter)return in_array($key, $filter);,
    ARRAY_FILTER_USE_KEY
  );
  $i--;

print_r($filtered);
echo microtime(true) - $time . " using array_filter\n\n";

$filtered = [];
$time = microtime(true);
$i = 1000000;
while($i) 
  foreach ($filter as $key)
    if(array_key_exists($key, $arr))
      $filtered[$key] = $arr[$key];
  $i--;

print_r($filtered);
echo microtime(true) - $time . " using foreach + array_key_exists\n\n";

0.28603601455688 使用 array_intersect_key 1.3096671104431 使用 array_filter 0.19402384757996 使用 foreach + array_key_exists

array_filter 的“问题”是它将循环遍历 $arr 的所有元素，而 array_filter 和 foreach 仅循环遍历 $filter。后者效率更高，假设 $filter 小于 $arr。

【讨论】：

【参考方案3】：

PHP 5.6 为array_filter() 引入了第三个参数flag，您可以将其设置为ARRAY_FILTER_USE_KEY 以通过键而不是值进行过滤：

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

由于 PHP 7.4 引入了箭头函数，我们可以让它更简洁：

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

显然这不如array_intersect_key($my_array, array_flip($allowed)) 优雅，但它确实提供了对密钥执行任意测试的额外灵活性，例如$allowed 可以包含正则表达式模式而不是纯字符串。

您还可以使用ARRAY_FILTER_USE_BOTH 将值和键都传递给您的过滤器函数。这是一个基于第一个的人为示例，但请注意，我不建议这样使用$allowed 编码过滤规则：

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

【讨论】：

该死，作为该功能的author，我应该寻找这个问题;-) 谢谢，这比array_intersect好 PHP 7.4+ $filtered = array_filter( $my_array, fn ($key) => in_array($key, $allowed), ARRAY_FILTER_USE_KEY );【参考方案4】：

//过滤掉key小于4个字符的数组元素 // 通过使用带有闭包的匿名函数...

function comparison($min)

   return function($item) use ($min)  
      return strlen($item) >= $min;   
   ; 


$input = array(
  0      => "val 0",
  "one"  => "val one",
  "two"  => "val two",
  "three"=> "val three",
  "four" => "val four",  
  "five" => "val five",    
  "6"    => "val 6"    
);

$output = array_filter(array_keys($input), 比较(4));

print_r($output);

【讨论】：

【参考方案5】：

幼稚丑陋（但似乎更快）的解决方案？

只在 php 7.3.11 中尝试过这个，但一个丑陋的循环似乎在大约三分之一的时间内执行。具有几百个键的数组上的类似结果。微优化，在 RW 中可能没用，但发现它令人惊讶和有趣：

$time = microtime(true);
$i = 100000;
while($i) 
    $my_array = ['foo' => 1, 'hello' => 'world'];
    $allowed  = ['foo', 'bar'];
    $filtered = array_filter(
        $my_array,
        function ($key) use ($allowed) 
            return in_array($key, $allowed);
        ,
        ARRAY_FILTER_USE_KEY
    );
    $i--;

print_r($filtered);
echo microtime(true) - $time . ' on array_filter';

// 0.40600109100342 on array_filter
$time2 = microtime(true);
$i2 = 100000;
while($i2) 
    $my_array2 = ['foo' => 1, 'hello' => 'world'];
    $allowed2  = ['foo', 'bar'];
    $filtered2 = [];
    foreach ($my_array2 as $k => $v) 
        if (in_array($k, $allowed2)) $filtered2[$k] = $v;
    
    $i2--;

print_r($filtered2);
echo microtime(true) - $time2 . ' on ugly loop';
// 0.15677785873413 on ugly loop

【讨论】：

【参考方案6】：

$elements_array = ['first', 'second'];

删除一些数组元素的函数

function remove($arr, $data) 
    return array_filter($arr, function ($element) use ($data) 
        return $element != $data;
    );

调用并打印

print_r(remove($elements_array, 'second'));

结果 Array ( [0] => first )

【讨论】：

问题是关于过滤数组键而不是值。【参考方案7】：

来自php的数组过滤函数：

array_filter ( $array, $callback_function, $flag )

$array - 它是输入数组

$callback_function - 使用的回调函数，如果回调函数返回true，则从数组中返回当前值到结果数组中。

$flag - 它是可选参数，它将决定将哪些参数发送到回调函数。如果此参数为空，则回调函数将数组值作为参数。如果您想发送数组键作为参数，则使用 $flag 作为 ARRAY_FILTER_USE_KEY。如果你想同时发送键和值，你应该使用 $flag as ARRAY_FILTER_USE_BOTH。

例如：考虑简单的数组

$array = array("a"=>1, "b"=>2, "c"=>3, "d"=>4, "e"=>5);

如果要根据数组键过滤数组，我们需要使用ARRAY_FILTER_USE_KEY作为数组函数array_filter的第三个参数。

$get_key_res = array_filter($array,"get_key",ARRAY_FILTER_USE_KEY );

如果要根据数组键和数组值过滤数组，我们需要使用ARRAY_FILTER_USE_BOTH作为数组函数array_filter的第三个参数。

$get_both = array_filter($array,"get_both",ARRAY_FILTER_USE_BOTH );

示例回调函数：

 function get_key($key)
 
    if($key == 'a')
    
        return true;
     else 
        return false;
    

function get_both($val,$key)

    if($key == 'a' && $val == 1)
    
        return true;
       else 
        return false;

会输出

Output of $get_key is :Array ( [a] => 1 ) 
Output of $get_both is :Array ( [a] => 1 )

【讨论】：

【参考方案8】：

使用array_intersect_key 和array_flip：

var_dump(array_intersect_key($my_array, array_flip($allowed)));

array(1) 
  ["foo"]=>
  int(1)

【讨论】：

我很好奇这是否比我的解决方案更有效？它绝对更优雅:) @GWW，一般来说，我发现这些类型的数组函数比等效的 foreach 循环更快（有时相当快），但唯一确定的方法是对它们计时都在相同的数据上。为什么使用array_flip？只需使用键定义$allowed：allowed = array ( 'foo' => 1, 'bar' => 1 );【参考方案9】：

使用此功能可以过滤多维数组

function filter_array_keys($array,$filter_keys=array())

    $l=array(&$array);
    $c=1;
    //This first loop will loop until the count var is stable//
    for($r=0;$r<$c;$r++)
        //This loop will loop thru the child element list//
        $keys = array_keys($l[$r]);

        for($z=0;$z<count($l[$r]);$z++)
            $object = &$l[$r][$keys[$z]];

            if(is_array($object))
                $i=0;
                $keys_on_array=array_keys($object);
                $object=array_filter($object,function($el) use(&$i,$keys_on_array,$filter_keys)
                    $key = $keys_on_array[$i];
                    $i++;

                    if(in_array($key,$filter_keys) || is_int($key))return false;                
                    return true;                        
                );
            

            if(is_array($l[$r][$keys[$z]]))
                $l[] = &$l[$r][$keys[$z]];
                $c++;
            //IF           
        //FOR
    //FOR  

    return $l[0];

【讨论】：

【参考方案10】：

从 PHP 5.6 开始，您可以在 array_filter 中使用 ARRAY_FILTER_USE_KEY 标志：

$result = array_filter($my_array, function ($k) use ($allowed) 
    return in_array($k, $allowed);
, ARRAY_FILTER_USE_KEY);

否则，您可以使用此功能（from TestDummy）：

function filter_array_keys(array $array, $callback)

    $matchedKeys = array_filter(array_keys($array), $callback);

    return array_intersect_key($array, array_flip($matchedKeys));


$result = filter_array_keys($my_array, function ($k) use ($allowed) 
    return in_array($k, $allowed);
);

这是我的增强版本，它接受回调或直接接受键：

function filter_array_keys(array $array, $keys)

    if (is_callable($keys)) 
        $keys = array_filter(array_keys($array), $keys);
    

    return array_intersect_key($array, array_flip($keys));


// using a callback, like array_filter:
$result = filter_array_keys($my_array, function ($k) use ($allowed) 
    return in_array($k, $allowed);
);

// or, if you already have the keys:
$result = filter_array_keys($my_array, $allowed));

最后但同样重要的是，您也可以使用简单的foreach：

$result = [];
foreach ($my_array as $key => $value) 
    if (in_array($key, $allowed)) 
        $result[$key] = $value;

【讨论】：

【参考方案11】：

如果您只需要一次，这可能有点过头了，但您可以使用YaLinqo library* 来过滤集合（并执行任何其他转换）。该库允许对具有流畅语法的对象执行类似 SQL 的查询。它的where 函数接受一个带有两个参数的回调：一个值和一个键。例如：

$filtered = from($array)
    ->where(function ($v, $k) use ($allowed) 
        return in_array($k, $allowed);
    )
    ->toArray();

（where 函数返回一个迭代器，因此如果您只需要使用foreach 对结果序列进行一次迭代，则可以删除->toArray()。）

_{*我开发的}

【讨论】：

【参考方案12】：

使用`array_filter`时如何获取数组的当前key

不管我多么喜欢文森特对马切克问题的解决方案，它实际上并没有使用array_filter。如果您从搜索引擎来到这里，您可能会在哪里寻找类似的东西 (PHP >= 5.3)：

$array = ['apple' => 'red', 'pear' => 'green'];
reset($array); // Unimportant here, but make sure your array is reset

$apples = array_filter($array, function($color) use ($&array) 
  $key = key($array);
  next($array); // advance array pointer

  return key($array) === 'apple';

它将您过滤的数组作为回调的引用传递。由于array_filter 通常不会通过增加它的公共内部指针来迭代数组，因此您必须自己推进它。

这里重要的是您需要确保您的阵列已重置，否则您可能会从中间开始。

在 PHP >= 5.4 中，您可以使回调更短：

$apples = array_filter($array, function($color) use ($&array) 
  return each($array)['key'] === 'apple';

【讨论】：

【参考方案13】：

如果您正在寻找一种通过键中出现的字符串过滤数组的方法，您可以使用：

$mArray=array('foo'=>'bar','foo2'=>'bar2','fooToo'=>'bar3','baz'=>'nope');
$mSearch='foo';
$allowed=array_filter(
    array_keys($mArray),
    function($key) use ($mSearch)
        return stristr($key,$mSearch);
    );
$mResult=array_intersect_key($mArray,array_flip($allowed));

print_r($mResult)的结果是

Array ( [foo] => bar [foo2] => bar2 [fooToo] => bar3 )

支持正则表达式的这个答案的改编

function array_preg_filter_keys($arr, $regexp) 
  $keys = array_keys($arr);
  $match = array_filter($keys, function($k) use($regexp) 
    return preg_match($regexp, $k) === 1;
  );
  return array_intersect_key($arr, array_flip($match));


$mArray = array('foo'=>'yes', 'foo2'=>'yes', 'FooToo'=>'yes', 'baz'=>'nope');

print_r(array_preg_filter_keys($mArray, "/^foo/i"));

输出

Array
(
    [foo] => yes
    [foo2] => yes
    [FooToo] => yes
)

【讨论】：

感谢您的回答。我会向您提交，在函数的“工作”中使用stristr 正在为最终用户做出一些假设。也许让用户传入正则表达式会更好；这将使他们在锚点、单词边界和区分大小写等某些方面具有更大的灵活性。我添加了对您的答案的改编，可能对其他人有所帮助你当然是对的，maček，对于熟悉正则表达式的用户来说，这是一种更通用的方法。谢谢。【参考方案14】：

我也需要这样做，但在键上使用更复杂的array_filter。

我是这样做的，使用了类似的方法。

// Filter out array elements with keys shorter than 4 characters
$a = array(
  0      => "val 0", 
  "one"  => "val one", 
  "two"  => "val two", 
  "three"=> "val three", 
  "four" => "val four", 
  "five" => "val five", 
  "6"    => "val 6"
); 

$f = array_filter(array_keys($a), function ($k) return strlen($k)>=4; ); 
$b = array_intersect_key($a, array_flip($f));
print_r($b);

这会输出结果：

Array
(
    [three] => val three
    [four] => val four
    [five] => val five
)

【讨论】：

从 PHP 8.1 开始，strlen 现在会发出一个已弃用的错误“strlen(): Passing null to parameter #1 ($string) of string is deprecated”【参考方案15】：

这是一个使用闭包的更灵活的解决方案：

$my_array = array("foo" => 1, "hello" => "world");
$allowed = array("foo", "bar");
$result = array_flip(array_filter(array_flip($my_array), function ($key) use ($allowed)

    return in_array($key, $allowed);
));
var_dump($result);

输出：

array(1) 
  'foo' =>
  int(1)

所以在函数中，你可以做其他具体的测试。

【讨论】：

我不会把这称为“更灵活”；感觉也比公认的解决方案简单得多。我同意。如果条件更复杂，它会更灵活。只是路过，对于其他用户：此解决方案不处理 $my_array 具有重复值或不是整数或字符串的值的情况。所以我不会使用这个解决方案。我同意这更灵活，因为它允许您更改过滤器逻辑。例如，我使用了一个不允许的键数组并简单地返回 !in_array($key, $disallowed)。【参考方案16】：

这是使用unset() 的不太灵活的替代方案：

$array = array(
    1 => 'one',
    2 => 'two',
    3 => 'three'
);
$disallowed = array(1,3);
foreach($disallowed as $key)
    unset($array[$key]);

print_r($array) 的结果是：

Array
(
    [2] => two
)

如果您想保留过滤值以供以后使用但更整洁，如果您确定不这样做，则此方法不适用。

【讨论】：

在 unset 之前，您应该检查 $array 中是否存在键 $key。 @JarekJakubowski 在使用unset() 时，您不需要检查数组键是否存在。如果密钥不存在，则不会发出警告。

以上是关于PHP：如何使用 array_filter() 过滤数组键？的主要内容，如果未能解决你的问题，请参考以下文章

PHP array_filter() 函数

PHP 数组过滤空值 array_filter

php array_filter 没有密钥保存

array_filter() 期望参数 1 是 PHP 中的数组

array_filter函数

php利用array_filter()过滤数组空值

PHP：如何使用 array_filter() 过滤数组键？

使用array_filter时如何获取数组的当前key

使用`array_filter`时如何获取数组的当前key