trigger_error

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

trigger_error — Gera uma mensagem a nível de usuário de erro/alerta/nota

Descrição

trigger_error(string $message, int $error_level = E_USER_NOTICE): true

Usado para disparar uma condição de erro, pode ser usado em conjunto com o gerenciador de erro interno, ou com uma função definida pelo usuário que tenha sido definida como novo gerenciador de erro (set_error_handler()).

Esta função é útil quando for necessário gerar uma resposta em particular a uma exceção em tempo de execução.

Parâmetros

message

A mensagem de erro designada para este erro. É limitada a 1024 bytes em tamanho. Quaisquer caracteres adicionais além de 1024 bytes serão truncados.

error_level

O tipo de erro designado para este erro. Funciona apenas com a família de constantes E_USER_*, e o padrão é E_USER_NOTICE.

Valor Retornado

Sempre retorna true.

Erros/Exceções

Esta função lança uma exceção ValueError se error_level não for uma das constantes E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE ou E_USER_DEPRECATED.

Registro de Alterações

Versão Descrição
8.0.0 A função agora lança uma exceção ValueError se um error_level inválido for especificado. Anteriormente, retornava false.

Exemplos

Example #1 Exemplo de trigger_error()

Consulte set_error_handler() para um exemplo mais extensivo. 

<?php
if (assert($divisor == 0)) {
    trigger_error("Não é possível dividir por zero", E_USER_ERROR);
}
?>

Notas

Warning

As entidades HTML contidas no parâmetro message não são escapadas. Utilize htmlentities() na mensagem se for necessário exibir o erro em um navegador.

Veja Também