Constantes em PHP: define() ou const e constantes mágicas

Uma constante é um nome para um valor que nunca muda enquanto o script roda. Declare com const MAX_USERS = 100; ou define('MAX_USERS', 100); e depois use o nome puro, sem $.

<?php
const SITE_NAME = "Coffee Corner";
define("MAX_ITEMS", 5);

echo SITE_NAME, "\n";
echo "You can order up to " . MAX_ITEMS . " items\n";

$price = 3.5;
const TAX_RATE = 0.2;
echo "Total: ", $price * (1 + TAX_RATE), "\n";

Por convenção, nomes de constantes ficam em UPPER_SNAKE_CASE. Elas são globais: uma constante declarada no topo de um arquivo é visível dentro de todas as funções sem global.

define() ou const

Os dois criam uma constante, mas funcionam em momentos diferentes. const é resolvido quando o PHP compila o arquivo, define() roda como qualquer outra chamada de função.

<?php
// const accepts expressions made of literals and other constants
const SECONDS_PER_DAY = 24 * 60 * 60;
const GREETING = "Hello, " . "world";

// define() can run conditionally and take a computed name
$env = "dev";
if ($env === "dev") {
    define("DEBUG", true);
}
foreach (["RED" => "#f00", "GREEN" => "#0f0"] as $name => $hex) {
    define("COLOR_" . $name, $hex);
}

echo SECONDS_PER_DAY, "\n";
echo GREETING, "\n";
var_dump(DEBUG);
echo COLOR_GREEN, "\n";

Use const por padrão, porque é mais curto e verificado em tempo de compilação. Use define() quando a constante depender de uma condição ou de um nome calculado.

Constantes não podem ser alteradas

Atribuir a uma constante é um erro de sintaxe:

<?php
const LIMIT = 10;
LIMIT = 20;

PHP Parse error:  syntax error, unexpected token "=" in /home/index.php on line 3

Definir a mesma constante duas vezes não é erro, mas o PHP imprime um aviso e mantém o primeiro valor:

<?php
define("LIMIT", 10);
define("LIMIT", 20);
echo LIMIT; // 10

Warning: Constant LIMIT already defined in /home/index.php on line 3

Quando um valor talvez já esteja definido (por exemplo, num arquivo de configuração carregado mais de uma vez), verifique antes com defined():

<?php
if (!defined("APP_ENV")) {
    define("APP_ENV", "production");
}
if (!defined("APP_ENV")) {
    define("APP_ENV", "testing");   // skipped
}
echo APP_ENV, "\n";

var_dump(defined("APP_ENV"));
var_dump(defined("NOT_THERE"));

// Read a constant whose name is in a string
$name = "APP_ENV";
echo constant($name), "\n";

Arrays constantes

Uma constante pode guardar um array. Você pode lê-lo com NAME[key], percorrê-lo e passá-lo adiante, mas não modificá-lo.

<?php
const WEEKDAYS = ["Mon", "Tue", "Wed", "Thu", "Fri"];
define("HTTP_CODES", [200 => "OK", 404 => "Not Found", 500 => "Server Error"]);

echo WEEKDAYS[0], "\n";
echo count(WEEKDAYS), " weekdays\n";
echo HTTP_CODES[404], "\n";

foreach (HTTP_CODES as $code => $text) {
    echo "$code $text\n";
}

Constantes de classe

Dentro de uma classe, const declara uma constante que pertence à classe. Leia com ClassName::NAME de fora e self::NAME ou static::NAME de dentro. Constantes de classe podem ter visibilidade, podem ser final e, desde o PHP 8.3, podem declarar um tipo.

<?php
class Order
{
    public const STATUS_NEW = "new";
    public const STATUS_PAID = "paid";
    private const MAX_LINES = 50;
    final public const string CURRENCY = "EUR";   // typed, PHP 8.3

    public function __construct(public string $status = self::STATUS_NEW) {}

    public function canAddLine(int $lines): bool
    {
        return $lines < self::MAX_LINES;
    }
}

$order = new Order();
echo $order->status, "\n";
echo Order::STATUS_PAID, "\n";
echo Order::CURRENCY, "\n";
var_dump($order->canAddLine(10));

// Dynamic access by name
$which = "STATUS_PAID";
echo constant("Order::$which"), "\n";

Um grupo de constantes de classe relacionadas, como STATUS_NEW e STATUS_PAID, muitas vezes fica melhor como um enum, que também impede que valores inválidos circulem pelo código.

Constantes mágicas: LINE, FILE, DIR e outras

Constantes mágicas mudam de valor conforme o lugar onde aparecem. Elas são preenchidas em tempo de compilação.

<?php
namespace App\Billing;

class Invoice
{
    public function describe(): string
    {
        return "class: " . __CLASS__ . "\n"
            . "method: " . __METHOD__ . "\n"
            . "function: " . __FUNCTION__ . "\n";
    }
}

echo (new Invoice())->describe();
echo "namespace: ", __NAMESPACE__, "\n";
echo "line: ", __LINE__, "\n";
echo "file: ", basename(__FILE__), "\n";
echo "dir is a directory: ", var_export(is_dir(__DIR__), true), "\n";

A mais usada é __DIR__, o diretório do arquivo atual. Montar caminhos de include a partir dela faz com que funcionem não importa de qual diretório o script foi iniciado: require __DIR__ . '/config.php';. Veja include e require para o padrão completo.

Constantes nativas que vale a pena conhecer

O PHP define muitas constantes próprias. Estas aparecem o tempo todo:

<?php
echo "PHP_VERSION:   ", PHP_VERSION, "\n";
echo "PHP_INT_MAX:   ", PHP_INT_MAX, "\n";
echo "PHP_INT_SIZE:  ", PHP_INT_SIZE, " bytes\n";
echo "PHP_FLOAT_EPSILON: ", PHP_FLOAT_EPSILON, "\n";
echo "M_PI:          ", M_PI, "\n";
echo "PHP_OS_FAMILY: ", PHP_OS_FAMILY, "\n";
echo "E_ALL:         ", E_ALL, "\n";
echo "PHP_EOL is a newline: ", var_export(PHP_EOL === "\n", true), PHP_EOL;

PHP_EOL é o fim de linha do sistema onde o PHP roda ("\n" no Linux e no macOS, "\r\n" no Windows). Ela serve para texto escrito em arquivos e no terminal; na saída HTML uma quebra de linha não aparece, então use <br> ali.