ini_get
(PHP 4, PHP 5)
ini_get — Devuelve el valor de una directiva de configuración
Descripción
$varname
)En caso de éxito devuelve el valor de una directiva de configuración.
Parámetros
-
varname -
Nombre de la directiva de configuración.
Valores devueltos
Devuelve el valor de la opción de configuración como cadena en caso de éxito, o
una cadena vacía para valores null. Devuelve FALSE si la
opción de configuración no existe.
Ejemplos
Ejemplo #1 Unos cuantos ejemplos de la función ini_get()
<?php
/*
Dentro del php.ini tenemos las siguientes directivas junto con sus valores iniciales:
display_errors = On
register_globals = Off
post_max_size = 8M
*/
echo 'display_errors = ' . ini_get('display_errors') . "\n";
echo 'register_globals = ' . ini_get('register_globals') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n";
echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));
function return_bytes($val) {
$val = trim($val);
$last = strtolower($val[strlen($val)-1]);
switch($last) {
// El modificador 'G' está disponble desde PHP 5.1.0
case 'g':
$val *= 1024;
case 'm':
$val *= 1024;
case 'k':
$val *= 1024;
}
return $val;
}
?>
El resultado del ejemplo sería algo similar a:
display_errors = 1 register_globals = 0 post_max_size = 8M post_max_size+1 = 9 post_max_size in bytes = 8388608
Notas
Nota: Cuando se consultan valores booleanos
El valor booleano off será devuelto como una cadena vacía o "0", mientras que el valor booleano on será devuelto será devuelto como "1". Esta función también puede devolver valores iniciales como cadenas.
Nota: Cuando se consultan valores de tamaños de memoria
Muchos valores iniciales de tamaños de memoria, tales como upload_max_filesize, están almacenados en el fichero php.ini en notación abreviada. ini_get() devolverá la cadena exacta almacenada en el fichero php.ini y NO su valor de tipo integer equivalente. Utilizar estos valores en funciones aritméticas puede provocar resultados inesperados. El ejemplo anterior muestra una manera de convertir la notación abreviada a bytes, muy similar a cómo lo hace el código fuente de PHP.
Historial de cambios
| Versión | Descripción |
|---|---|
| 5.3.0 | Anteriormente, se devolvía un string si la opción de configuración
no existía. Ahora en su lugar se devuelve FALSE.
|
Ver también
- get_cfg_var() - Obtiene el valor de una opción de configuración de PHP
- ini_get_all() - Obtiene todas las opciones de configuración
- ini_restore() - Restablece el valor de una opción de configuración
- ini_set() - Establece el valor de una directiva de configuración