ini_get

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

ini_get — Obtém o valor de uma opção de configuração

Descrição

ini_get(string $option): string|false

Retorna o valor da opção de configuração em caso de sucesso.

Parâmetros

option: O nome da opção de configuração.

Valor Retornado

Retorna o valor da opção de configuração como uma string em caso de sucesso ou uma string vazia para valores null. Retorna false se a opção de configuração não existir.

Exemplos

Example #1 Alguns exemplos de ini_get()

<?php

/*
Considere o php.ini com as seguintes configurações:

display_errors = On
register_globals = Off
post_max_size = 8M
*/

echo 'display_errors = ' . ini_get('display_errors') . "\n";
echo 'register_globals = ' . (int) ini_get('register_globals') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size + 1 = ' . (rtrim(ini_get('post_max_size'), 'KMG') + 1) . "\n";
echo 'post_max_size em bytes = ' . return_bytes(ini_get('post_max_size'));

function return_bytes($val)
{
    $val = trim($val);
    $num = (int) rtrim($val, 'KMG');
    $last = strtolower($val[strlen($val) - 1]);

    switch ($last) {
        // O modificador 'G' está disponível
        case 'g':
            $num = $num * 1024 * 1024 * 1024;
            break;
        case 'm':
            $num = $num * 1024 * 1024;
            break;
        case 'k':
            $num *= 1024;
            break;
    }

    return $num;
}

?>

O exemplo acima produzirá algo semelhante a:

display_errors = 1
register_globals = 0
post_max_size = 8M
post_max_size+1 = 9
post_max_size em bytes = 8388608

Notas

Note: Ao consultar valores booleanos

Um valor booleano ini off será retornado como uma string vazia ou "0", enquanto um valor booleano ini on será retornado como "1". A função também pode retornar a string literal do valor INI.

Note: Ao consultar valores de tamanho de memória

Muitos valores de tamanho de memória ini, como upload_max_filesize, são armazenados no arquivo php.ini em notação abreviada. ini_get() retornará a string exata armazenada no arquivo php.ini e NÃO o seu equivalente int. Tentar funções aritméticas normais com esses valores não trará os resultados esperados. O exemplo acima mostra uma maneira de converter a notação abreviada em bytes, da mesma forma que a fonte PHP o faz.

Note:
ini_get() não consegue ler opções ini de "array" como, por exemplo, pdo.dsn.*, e retorna false neste caso.

Veja Também

get_cfg_var() - Obtém o valor de uma opção de configuração do PHP
ini_get_all() - Obtém todas as opções de configuração
ini_restore() - Restaura o valor de uma opção de configuração
ini_set() - Define o valor de uma opção de configuração