<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 596c11440dc232b8ed1836d7e3afe2ed5b225a7b Maintainer: girgias Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.array-filter" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>array_filter</refname>

<refpurpose>Filtre les éléments d'un tableau grâce à une fonction de rappel</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>array_filter</methodname>

<methodparam><type>array</type><parameter>array</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Évalue chaque valeur du tableau <parameter>array</parameter> en

les passant à la fonction de rappel <parameter>callback</parameter>.

Si la fonction de rappel <parameter>callback</parameter> retourne &true;,

la valeur courante du tableau <parameter>array</parameter> est retournée

dans le &array; résultant.

</para>

<para>

Les clés du tableau sont préservées, ce qui peut entraîner des anomalies si le

tableau <parameter>array</parameter> était indexé. Le tableau résultant

peut être réindexé en utilisant la fonction <function>array_values</function>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<para>

Le tableau à parcourir

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<para>

La fonction de rappel à utiliser

</para>

<para>

Si aucune fonction de rappel <parameter>callback</parameter> n'est fournie,

toutes les entrées vides du tableau <parameter>array</parameter> seront supprimées.

Voir la fonction <function>empty</function> pour comprendre la façon dont PHP gère

le vide dans ce cas.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>mode</parameter></term>

<listitem>

<para>

Drapeau indiquant quels sont les arguments à envoyer

à la fonction de rappel <parameter>callback</parameter> :

<itemizedlist>

<listitem>

<simpara>

<constant>ARRAY_FILTER_USE_KEY</constant> - passer la clé comme seul

argument à <parameter>callback</parameter> au lieu de la valeur.

</simpara>

</listitem>

<listitem>

<simpara>

<constant>ARRAY_FILTER_USE_BOTH</constant> - passer à la fois la

valeur et la clé comme arguments de <parameter>callback</parameter>

au lieu de la valeur.

</simpara>

</listitem>

</itemizedlist>

Par défaut <literal>0</literal>, qui passera la valeur comme

seul argument de <parameter>callback</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne le tableau filtré.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>callback</parameter> est désormais nullable.

</entry>

</row>

&array.changelog.by-ref;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <function>array_filter</function></title>

<programlisting role="php">

<![CDATA[

<?php

function odd($var)

{

// retourne si l'entier en entrée est impair

return $var & 1;

}

function even($var)

{

// retourne si l'entier en entrée est pair

return !($var & 1);

}

$array1 = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5];

$array2 = [6, 7, 8, 9, 10, 11, 12];

echo "Impair :\n";

print_r(array_filter($array1, "odd"));

echo "Pair :\n";

print_r(array_filter($array2, "even"));

?>

]]>

</programlisting>

&example.outputs;

<screen role="php">

<![CDATA[

Impair :

Array

(

[a] => 1

[c] => 3

[e] => 5

)

Pair :

Array

(

[0] => 6

[2] => 8

[4] => 10

[6] => 12

)

]]>

</screen>

</example>

<example>

<title>Exemple avec <function>array_filter</function> sans

<parameter>callback</parameter></title>

<programlisting role="php">

<![CDATA[

<?php

$entry = [

0 => 'foo',

1 => false,

2 => -1,

3 => null,

4 => '',

5 => '0',

6 => 0,

];

print_r(array_filter($entry));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

Array

(

[0] => foo

[2] => -1

)

]]>

</screen>

</example>

<example>

<title>Exemple avec <function>array_filter</function> et

<parameter>mode</parameter></title>

<programlisting role="php">

<![CDATA[

<?php

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

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

array(1) {

["b"]=>

int(2)

}

array(2) {

["b"]=>

int(2)

["d"]=>

int(4)

}

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<caution>

<para>

Si le tableau est modifié depuis la fonction de rappel (par exemple

des éléments sont ajoutés ou détruits), le comportement

de cette fonction est indéfini.

</para>

</caution>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_intersect</function></member>

<member><function>array_find</function></member>

<member><function>array_any</function></member>

<member><function>array_map</function></member>

<member><function>array_reduce</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->