如何使用索引数组中的值与关联数组中的键进行比较来过滤关联数组？

Question

如何使用索引数组中的值与关联数组中的键进行比较来过滤关联数组？

454

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

如果我有：

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

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

如何删除$my_array中所有不在$allowed数组中的键？

期望输出：

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

- maček

不是解决方案，但另一种可能有用的方法是 $b = ['foo' => $a['foo'], 'bar' => $a['bar']]。这将导致 $b['bar'] 为 null。 - oriadam

12个回答

469

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) {
        // N.b. in_array() is notorious for being slow 
        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,
    fn ($val, $key) => isset($allowed[$key]) && (
        $allowed[$key] === true || $allowed[$key] === $val
    ),
    ARRAY_FILTER_USE_BOTH
); // ['foo' => 1, 'bar' => 'baz']

- Richard Turner

33

该功能的作者在看到这个问题时，感到非常抱歉。 - Ja͢ck

1

PHP 7.4+

$filtered = array_filter(
    $my_array,
    fn ($key) => in_array($key, $allowed),
    ARRAY_FILTER_USE_KEY
);

- jartaud

任何利用in_array()的迭代调用的答案都不会比更优雅的array_intersect_key()调用更有效。是的，查找数组需要翻转一次，但由于PHP非常快速地进行键查找（例如isset()），我预计在大多数测试用例中in_array()将被抛在后面。更简单地说，已经证明isset()在基准测试中远远优于in_array()。唯一需要注意的危险是当翻转技术改变值时--例如当您将浮点值翻转为键时，它变成了整数。 - mickmackusa

2

@mickmackusa 你可能需要一个大数组才能使差异对应用程序的运行产生显著影响。通常可读性胜过性能微观优化。但这肯定是需要注意的事情。 - Richard Turner

你的代码片段没有任何可取之处，我不会在自己的项目中使用它们。VincentSavard的flip＆intersect_key技术更高效、更简洁、更优雅、更易读，并且适当地利用了完全本地的函数式方法。我并不是在攻击你，我只是在比较这些帖子。 - mickmackusa

10

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

$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)
}

因此在这个函数中，您可以进行其他特定的测试。

- COil

1

我不会完全称之为“更灵活”; 它感觉比已接受的解决方案更加复杂。 - maček

我同意。如果条件更复杂一些会更灵活。 - COil

1

只是路过，给其他用户提供参考：这个解决方案没有处理$my_array具有重复值或不是整数或字符串的情况。因此，我不会使用这个解决方案。 - user23127

2

我同意这种方法更加灵活，因为它允许您更改过滤逻辑。例如，我使用了一个不允许的键数组，并简单地返回了!in_array($key, $disallowed)。 - nfplee

调用 array_flip($my_array) 是危险的。如果数组中存在重复值，则数组的大小将会减小，因为在同一级别上数组不能有重复的键。这种方法不应该被使用——它是不稳定/不可靠的。 - mickmackusa

4

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

尽管我喜欢Vincent提供的解决方案，但它实际上并没有使用array_filter。如果您从搜索引擎进入此处，并且想要在array_filter的回调函数中访问当前迭代的键，您可能正在寻找类似于以下内容的解决方案（PHP >= 5.3）：

$my_array = ["foo" => 1, "hello" => "world"];

$allowed = ["foo", "bar"];

reset($my_array ); // Unnecessary in this case, as we just defined the array, but
                   // make sure your array is reset (see below for further explanation).

$my_array = array_filter($my_array, function($value) use (&$my_array, $allowed) {
  $key = key($my_array); // request key of current internal array pointer
  next($my_array); // advance internal array pointer

  return isset($allowed[$key]);
});

// $my_array now equals ['foo' => 1]

它将你要过滤的数组作为引用传递给回调函数。因为array_filter不会按照增加其公共内部指针的方式惯常迭代数组，所以你需要自己进行指针的移动。

重要的是，你需要确保重新设置数组，否则你可能会从中间开始（因为内部数组指针被你之前执行的某些代码留在那里）。

- flu

这个回答完全忽略了提问者的要求和样本数据。最好情况下，这个回答是针对另一个问题的正确答案......但实际上并不是。$&array 不是有效的 PHP 代码，并且 each() 已经自 PHP7.2 开始废弃，并在 PHP8 中被彻底移除。 - mickmackusa

嗨@mickmackusa，感谢您的友善和建设性的话语。七年前，当我写下这个答案时，PHP 8甚至还没有出现在地平线上，而each()也没有被弃用。在我看来，我的回答的要点可以轻松地转移到提问者的问题上，但我已经相应地更新了它，现在可以直接复制粘贴而无需过多考虑。我还修正了引用中的小错别字（$& => &$）。如果您对我的回答仍有不满意之处，请随意编辑。干杯！ - flu

请注意，这个问题被称为“如何使用array_filter()过滤数组键？”（参见：https://stackoverflow.com/posts/4260086/revisions），并且是在PHP 5.6不是很普及的时候提出的，因此新的ARRAY_FILTER_USE_KEY标志并不常见。所有在SO上的答案都是时代的产物，可能在半个多十年后已经无效、不准确或者不再有帮助了。我其实不知道现在已经弃用的答案是否应该因为历史原因而保留或删除。有人可能仍然被迫支持使用已经过时的PHP版本的项目。 - flu

请问，如果您是一位研究人员，正在寻找在应用程序中实现“最佳”方法，您是否认为这个答案“值得阅读”？有时候，即使不是最优解，发布的答案也具有“学术价值”。如果您认为您的帖子对未来的研究人员有帮助，请保留它。如果您认为它会给一个有11个不同答案的页面增加不必要的内容，则请删除该帖子以节省研究人员的时间。即使是十年前的页面也需要在SO上进行维护，这就是为什么我监控新旧页面的原因。我比普通用户更关心我们的内容。 - mickmackusa

作为一名研究人员，我不会更改七年前问题的标题（可能也是大多数答案的主题）。从研究人员的角度来看，如果在七年前，当 PHP 5.5 安装在超过一半的系统上并且没有 ARRAY_FILTER_USE_KEY 标志时，是否有一种方法“使用 array_filter() 过滤数组键？”这将非常有趣。像这样的问题有很多，它们提出了一个挑战：这真的可能吗？由于当时没有任何答案实际使用 array_filter，所以我认为我的答案仍然有价值。 - flu

1

我认为已弃用的答案仍应该可用。

为了历史记录，以及可能仍在使用旧版php（或其他语言）的人们。
例如，使用过php 5.2的人将知道如何将答案适应新版本的php。

- emilushi

4

这里是一个不太灵活的替代方案，使用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
)

如果您想将过滤后的值保留以供以后使用，但更加整洁，那么这不适用于您，如果您确定您不需要这样做。

- Alastair

2

在执行 unset 操作之前，您应该先检查 $array 中是否存在 $key。 - Jarek Jakubowski

4

当使用 unset() 函数时，无需检查数组键是否存在，即使键不存在也不会发出警告。 - Christopher

1

我还没有对这个页面上的可行解决方案进行基准测试，但这可能是最高效的竞争者之一。 - mickmackusa

4

参照@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";

使用array_intersect_key的话，时间复杂度为0.28603601455688。
使用array_filter的话，时间复杂度为1.3096671104431。
使用foreach + array_key_exists的话，时间复杂度为0.19402384757996。

array_filter的问题在于它会遍历$arr的所有元素，而array_intersect_key和foreach只会遍历$filter。假设$filter比$arr小，则后两种方法更有效率。

- CrAzY_pRoGrAmMeR

为什么Alastair的代码片段没有被包含在基准测试中？ - mickmackusa

正如他自己所承认的那样，他的代码功能与我测试过的三个代码不同。在他的情况下，$array（在我的代码中为$arr）被修改（unset）；而在我的情况下，$arr保持其原始状态。由于功能不同，因此进行比较是不公平的。 - CrAzY_pRoGrAmMeR

如果需要保留原始数组，那么在循环之前保存一份副本即可。将此成本添加到基准测试中。然后结果将是相同的。 - mickmackusa

4

如果你正在寻找一种通过键值中的字符串过滤数组的方法，你可以使用以下代码：

$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));

< p > print_r($mResult) 的结果为 < /p >

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
)

- Nicolas Zimmer

感谢您的回答。我想向您提出一个观点，即在函数的“工作”中使用stristr会对最终用户做出一些假设。也许允许用户传递一个正则表达式会更好，这将使他们在锚点、单词边界和大小写敏感等方面拥有更多的灵活性。 - maček

我添加了一个适应您答案的版本，可能会帮助其他人。 - maček

1

你说得没错，maček，对于熟悉正则表达式的用户来说，这是一种更加灵活的方法。谢谢。 - Nicolas Zimmer

这是对不同问题的正确答案。从数组中删除所有不以某个字符串开头的元素你的回答忽略了所提问的要求。 - mickmackusa

4

PHP中的数组过滤函数：

array_filter ( $array, $callback_function, $flag )

$array - 这是输入的数组。

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

$flag - 它是可选参数，它将确定发送到回调函数的参数。如果此参数为空，则回调函数将采用数组值作为参数。如果你想把数组键作为参数发送，那么应该使用$flag作为 ARRAY_FILTER_USE_KEY。如果你想发送键和值，那么应该使用$flag作为 ARRAY_FILTER_USE_BOTH 。

例如：考虑一个简单的数组

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

如果您想根据数组键（array key）筛选数组，则需要在array_filter的第三个参数中使用ARRAY_FILTER_USE_KEY函数。

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

如果您想根据数组键和数组值过滤数组，则需要在array_filter函数的第三个参数中使用ARRAY_FILTER_USE_BOTH。

$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 )

- prince jose

这个晚回答完全忽略了所提出的问题的要求。最多也只能算是对另一个问题的正确回答。 - mickmackusa

4

从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);

否则，你可以使用这个函数（来自 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;
    }
}

- Gras Double

我认为这个回答并没有提供任何新的价值。因为早期的回答已经提供了直接解决问题的方法，所以这个回答似乎过于复杂、混乱或者是多余的。如果你能的话，请解释一下为什么你的回答应该留在页面上。 - mickmackusa

当我发布这个答案时，PHP 5.6 刚刚发布了一年，因此它远未在所有主机上可用，因此用户空间实现的有用性。那么，我的答案并不是提供一个准备好选择（不知道你在做什么）的解决方案。它是关于思考，逐步地如何以最佳方式解决问题。我期望读者在学习了答案后，应该已经理解了各种方法，并能够确定如何在他的使用情况下解决问题。 - Gras Double

1

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

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

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

* 由我开发

- Athari

in_array()是PHP中性能最差的数组搜索函数之一。添加库的开销只会进一步降低性能。由于两个本地函数或循环unset调用可以简洁地解决此问题，因此我永远不会使用库的方法。 - mickmackusa

虽然您在技术上是正确的，但在大多数情况下，这只是一种微小的优化。如果来自数据库或Web服务的数据有10-100个项目，则您正在执行总工作量的0.5％，例如，使其快5倍，这并没有实现任何目标。当然，如果我们谈论从RAM直接过滤100,000个项目，那么开销就相当大了。 - Athari

无论如何，这更多是一个例子，说明该库具有比发布后引入的笨重功能（例如带有ARRAY_FILTER_USE_KEY 的 array_filter），使用不寻常的其他语言没有的函数(array_flip) 或深入了解PHP架构（知道 unset 具有哈希表访问速度和 in_array 线性扩展）。 - Athari

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Vincent Savard · Accepted Answer

528

使用array_intersect_key和array_flip：

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

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

- Vincent Savard

1

@GWW，一般来说，我发现这些类型的数组函数比等价的“foreach”循环更快（有时甚至相当多），但确定的唯一方法是在相同数据上对它们进行计时。 - Matthew

2

为什么要使用 array_flip？只需使用键定义 $allowed： allowed = array ( 'foo' => 1, 'bar' => 1 ); - Yuval A.

@YuvalA。如果数组更大，则需要使用array_flip。 - Gabriel Beauchemin-Dauphinais

如何使用索引数组中的值与关联数组中的键进行比较来过滤关联数组？

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

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