Функция file_get_contents

La función file_get_contents lee el contenido de un archivo y lo devuelve como una cadena. Al primer parámetro se le pasa la ruta del archivo, al segundo - el indicador de inclusión de la ruta de búsqueda, al tercero - el contexto de flujo, al cuarto - el desplazamiento para comenzar la lectura, al quinto - la longitud máxima de datos.

El tercer parámetro es especialmente útil cuando se necesita buscar archivos en directorios estándar, especificados en la configuración de PHP, y no solo por la ruta absoluta.

Sintaxis

file_get_contents(
	string $filename,
	bool $use_include_path = false,
	?resource $context = null,
	int $offset = 0,
	?int $maxlen = null
): string|false

Parámetros

Parámetro	Descripción
`filename`	Ruta al archivo o URL
`use_include_path`	Si se establece en `true`, la función buscará el archivo en los directorios especificados en el parámetro include_path en la configuración de PHP en el archivo `php.ini`. Por defecto `false`.
`context`	Recurso de contexto de flujo
`offset`	Desplazamiento para comenzar la lectura
`maxlen`	Longitud máxima de datos a leer

Ejemplo

Lectura del contenido de un archivo local:

<?php
	$res = file_get_contents('data.txt');
	echo $res;
?>

Resultado de la ejecución del código:

'abcde'

Ejemplo

Lectura de parte de un archivo especificando desplazamiento y longitud:

<?php
	$res = file_get_contents('data.txt', false, null, 1, 3);
	echo $res;
?>

Resultado de la ejecución del código:

'bcd'

Ejemplo

Lectura del contenido de una página web:

<?php
	$res = file_get_contents('https://example.com');
	echo substr($res, 0, 50) . '...';
?>

Resultado de la ejecución del código:

'<!doctype html><html><head><title>Example D...'

Ejemplo

Búsqueda de un archivo en include_path:

<?php
	$res = file_get_contents('config.ini', true);
	echo $res;
?>

Resultado de la ejecución del código:

'config_data'

Parámetro de contexto de flujo

El parámetro context permite pasar un recurso de contexto de flujo, que puede modificar el comportamiento de la función cuando trabaja con archivos o recursos de red.

Recurso de contexto, creado por la función stream_context_create. Si no se requieren configuraciones especiales, se puede pasar null.

Capacidades del contexto:

Establecer encabezados HTTP en solicitudes
Configurar tiempos de espera de conexión
Especificar servidor proxy
Trabajar con parámetros SSL/TLS
Configurar acceso al sistema de archivos

Ejemplo de trabajo:

<?php
	$opts = [
		'http' => [
			'method' => "GET",
			'header' => "Accept-language: en\r\n"
		]
	];
	$context = stream_context_create($opts);
	$res = file_get_contents('https://example.com', false, $context);
?>

Ver también

la función file_put_contents,
que escribe datos en un archivo
la función fopen,
que abre un archivo
la función file,
que lee un archivo en un array de cadenas