define

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

define — Define uma constante com nome

Descrição

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

Define uma constante com nome em tempo de execução.

Parâmetros

constant_name

O nome da constante.

Note:

É possível definir constante pela função define() com nome reservado ou até mesmo com nome inválido, cujo valor pode (somente) ser recuperado com a função constant(). Entretanto, isto não é recomendado.

value

O valor da constante. No PHP 5, value precisa ser um valor do tipo scalar (int, float, string, bool ou null). No PHP 7, valores do tipo array também são aceitos.

Warning

Apesar de ser possível definir constantes do tipo resource, não é recomendado e pode causar comportamento imprevisível.

case_insensitive

Se definido para true, a constante será definida sem diferenciação de maiúsculas/minúsculas. O comportamento padrão é diferenciar, isto é, CONSTANT e Constant representam valores diferentes.

Warning

Definir constantes sem diferenciar maiúsculas/minúsculas tornou-se defasado a partir do PHP 7.3.0. A partir do PHP 8.0.0, somente false é um valor aceitável para este parâmetro, passar true irá gerar um alerta.

Note:

Constantes insensíveis a maiúsculas/minúsculas são armazenadas em minúsculas.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Registro de Alterações

Versão Descrição
8.0.0 Passar true para case_insensitive agora emite um E_WARNING. Passar false ainda é permitido.
7.3.0 case_insensitive tornou-se defasado e será removido na versão 8.0.0.
7.0.0 Valores do tipo array são permitidos.

Exemplos

Example #1 Defining Constants

<?php
define("CONSTANT", "Hello world.");
echo CONSTANT; // mostra "Hello world."
echo Constant; // mostra "Constant" e emite uma nota.

define("GREETING", "Hello you.", true);
echo GREETING; // mostra "Hello you."
echo Greeting; // mostra "Hello you."

// Funciona a partir do PHP 7
define('ANIMALS', array(
    'dog',
    'cat',
    'bird'
));
echo ANIMALS[1]; // mostra "cat"

?>

Example #2 Constantes com Nomes Reservados

Este exemplo ilustra a possibilidade de definir uma constante com o mesmo nome de uma constante mágica. Como o comportamento resultante obviamente é confuso, não é portanto recomendado fazê-lo na prática. 

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

O exemplo acima produzirá:

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

Veja Também