define
PHP Manual
PHP Manual»Fonctions diverses»define

define

(PHP 4, PHP 5, PHP 7, PHP 8)

define — Définit une constante

Description

function define(string $constant_name, mixed $value, bool $case_insensitive = false): bool

Définit une constante à l'exécution.

Liste de paramètres

constant_name

Le nom de la constante.

Note:

Il est possible de définir avec define() des constantes avec des noms réservés ou même invalides, où leurs valeurs peuvent (seulement) être récupérées avec la fonction constant(). Cependant, faire ceci n'est pas recommandé.

define() prend le nom comme une simple string et ne le résout pas par rapport au namespace courant. À l'intérieur de namespace My\Namespace;, define('MYCONST', 1) définit donc MYCONST dans le namespace global, silencieusement et sans erreur. Pour placer la constante dans un namespace, le namespace doit faire partie du nom, écrit sans séparateur de namespace initial, comme dans define('My\Namespace\MYCONST', 1) ou define(__NAMESPACE__ . '\MYCONST', 1). Contrairement à defined() et constant(), define() ne supprime pas un séparateur initial : define('\My\Namespace\MYCONST', 1) retourne true mais crée une constante qui ne pourra jamais être récupérée. Le nom étant une simple chaîne de caractères, les alias introduits par les instructions use ne lui sont pas appliqués. Dans une chaîne entre guillemets doubles, les séparateurs de namespace doivent être échappés, comme dans "My\\Namespace\\MYCONST".

value

La valeur de la constante.

Avertissement

Bien qu'il soit techniquement possible de définir des constantes de type resource, ceci est déconseillé et peut causer des comportements inattendus.

case_insensitive

S'il vaut true, la constante sera définie de manière insensible à la casse. Le comportement par défaut est sensible à la casse, c.-à-d. que CONSTANT et Constant représentent des valeurs différentes.

Avertissement

Définir des constantes insensibles à la casse est obsolète à partir de PHP 7.3.0. À partir de PHP 8.0.0, seul false est une valeur acceptable, passer true produira un avertissement.

Note:

Les constantes insensibles à la casse sont stockées en minuscule.

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Historique

Version Description
8.1.0 value peut désormais être un objet.
8.0.0 Passer true à case_insensitive émet désormais une E_WARNING. Passer false est toujours autorisé.
7.3.0 case_insensitive est obsolète et sera supprimée dans la version 8.0.0.

Exemples

Exemple #1 Définition d'une constante

<?php
define("CONSTANT", "Bonjour le monde.");
echo CONSTANT; // affiche "Bonjour le monde."
echo Constant; // affiche "Constant" et émet une alerte

define("GREETING", "Salut toi.", true);
echo GREETING; // affiche "Salut toi."
echo Greeting; // affiche "Salut toi."

// Fonctionne à partir de PHP 7
define('ANIMALS', array(
    'chien',
    'chat',
    'oiseaux'
));
echo ANIMALS[1]; // affiche "chat"

?>

Exemple #2 Constantes avec des Noms Réservés

Cet exemple illustre la possibilité de définir une constante avec le même nom qu'une constante magique. Puisque le comportement qui en résulte porte à confusion, cette pratique n'est pas recommandée.

<?php
var_dump(defined('__LINE__'));
var_dump(define('__LINE__', 'test'));
var_dump(constant('__LINE__'));
var_dump(__LINE__);
?>

L'exemple ci-dessus va afficher :

bool(false)
bool(true)
string(4) "test"
int(5)

Voir aussi

To Top