file_get_contents

file_get_contents(string $filename, [bool $use_include_path], [resource $context], [int $offset], [int $length]): string
```php

Similar a la función `file`, excepto que `file_get_contents` devuelve el fichero `filename` en una cadena, comenzando desde la posición `offset` y hasta `length` bytes. En caso de error, `file_get_contents` devuelve `false`.

`file_get_contents` es el método recomendado para leer el contenido de un fichero en una `string`. Utilizará un buffer en memoria si este mecanismo es soportado por el sistema, con el fin de mejorar el rendimiento.

> [!NOTE]
> Si se abre una URI con caracteres especiales, como espacios, es necesario codificar esta URI con la función `urlencode`.

## Parámetros

`filename`  
Nombre del fichero a leer.

`use_include_path`  
> [!NOTE]
> La constante `FILE_USE_INCLUDE_PATH` puede ser utilizada para activar la búsqueda en el [ruta de inclusión](#ini.include-path). Esto no es posible si [strict typing](#language.types.declarations.strict) está activado, ya que `FILE_USE_INCLUDE_PATH` es un `int`. Utilice `true` en su lugar.

`context`  
Un recurso de contexto válido, creado con la función `stream_context_create`. Si no es necesario utilizar un contexto específico, este parámetro puede ser omitido asignándole el valor `null`.

`offset`  
La posición desde la cual se comienza a leer en el flujo original. Una posición negativa cuenta desde el final del flujo.

El desplazamiento en el fichero (`offset`) no es soportado en ficheros remotos. Si se intenta desplazarse en un fichero que no es local puede funcionar en pequeños desplazamientos, pero el comportamiento puede no ser el esperado ya que el proceso utiliza el flujo del buffer.

`length`  
El tamaño máximo de datos a leer. El comportamiento por defecto es leer hasta el final del fichero. Este parámetro se aplica al flujo procesado por los filtros.

## Valores devueltos

Devuelve los datos leídos o `false` si ocurre un error.

> [!WARNING]
> Esta función puede retornar `false`, pero también puede retornar un valor equivalente a `false`. Por favor, lea la sección sobre los [booleanos](#language.types.boolean) para más información. Utilice el [operador ===](#language.operators.comparison) para probar el valor de retorno exacto de esta función.

## Errores/Excepciones

Genera una advertencia de tipo `E_WARNING` si, `filename` no puede ser encontrado, si el parámetro `length` es menor que cero, o si el desplazamiento a la posición `offset` especificado en el flujo falla.

Cuando `file_get_contents` es llamado sobre un directorio, se genera un error de nivel `E_WARNING` en Windows, y a partir de PHP 7.4 en otros sistemas operativos también.

## Historial de cambios

| Versión | Descripción                                          |
|---------|------------------------------------------------------|
| 8.0.0   | `length` ahora es nullable.                          |
| 7.1.0   | Se añade soporte para posiciones `offset` negativas. |

## Ejemplos

Lee y muestra el código HTML de un sitio web

Busca un fichero en el include_path

Lee una sección de un fichero

Resultado del ejemplo anterior es similar a:

    string(14) "lle Bjori Ro"

Uso de contextos de flujo