Les valeurs de retour

Les valeurs sont renvoyées en utilisant une instruction de retour optionnelle. Tous les types de variables peuvent être renvoyés, tableaux et objets compris. Cela fait que la fonction finit son exécution immédiatement et passe le contrôle à la ligne appelante. Voir return pour plus d'informations.

Note:
Si return est omis, la valeur NULL sera retournée.

Utilisation de return

Exemple #1 Utilisation de return


<?php
function carre($num)
{
    return $num * $num;
}
echo carre(4); // Affiche '16'
?>

Une fonction ne peut pas renvoyer plusieurs valeurs en même temps, mais vous pouvez obtenir le même résultat en renvoyant un tableau.

Exemple #2 Retourner un tableau d'une fonction


<?php
function petit_nombre()
{
    return array (0, 1, 2);
}
list ($zero, $un, $deux) = petit_nombre();
?>

Pour retourner une référence d'une fonction, utilisez l'opérateur & aussi bien dans la déclaration de la fonction que dans l'assignation de la valeur de retour.

Exemple #3 Retourner une référence d'une fonction


<?php
function &retourne_reference()
{
    return $uneref;
}

$newref =& retourne_reference();
?>

Pour plus d'informations sur les références, référez-vous à l'explication sur les références.

Déclaration des types de retour

PHP 7 ajoute le support des déclarations du type de retour. De façon similaire aux déclarations du type des arguments, les déclarations du type de retour spécifient le type de la valeur qui sera retournée par une fonction. Les mêmes types sont disponibles pour le typage du retour que pour le typage des arguments.

Le typage strict affecte aussi les déclarations du type de retour. Dans le mode faible par défaut, les valeurs retournées seront transtypées vers le type demandé si elles ne sont pas déjà de celui-ci. Dans le mode strict, la valeur retournée doit être du bon type sinon une exception TypeError sera levée.

Depuis PHP 7.1.0, les valeurs de retour peuvent être marqué comme nullable en préfixant le nom du type avec un point d'interrogation (?). Ceci signifie que la function retourne soit le type spécifier soit NULL.

Note:
Lors de la surcharge d'une méthode parente, la méthode fille doit retourner une valeur cohérente avec le type de valeur retournée par la méthode parente. Si le parent ne définit par de type de retour, il doit en être de même pour la fille.

Exemples

Exemple #4 Déclaration basique de type de retour


<?php
function sum($a, $b): float {
    return $a + $b;
}

// Note qu'une valeur flottante sera retournée.
var_dump(sum(1, 2));
?>

L'exemple ci-dessus va afficher :

float(3)

Exemple #5 Le mode strict en action


<?php
declare(strict_types=1);

function sum($a, $b): int {
    return $a + $b;
}

var_dump(sum(1, 2));
var_dump(sum(1, 2.5));
?>

L'exemple ci-dessus va afficher :

int(3)

Fatal error: Uncaught TypeError: Return value of sum() must be of the type integer, float returned in - on line 5 in -:5
Stack trace:
#0 -(9): sum(1, 2.5)
#1 {main}
  thrown in - on line 5

Exemple #6 Retourner un objet


<?php
class C {}

function getC(): C {
    return new C;
}

var_dump(getC());
?>

L'exemple ci-dessus va afficher :

object(C)#1 (0) {
}

Exemple #7 Déclaration d'un type de retour nullable (depuis PHP 7.1.0)


<?php
function get_item(): ?string {
    if (isset($_GET['item'])) {
        return $_GET['item'];
    } else {
        return null;
    }
}
?>