Understanding PHP's file_get_contents() Function: Syntax, Parameters, Return Values, and Usage Examples

The file_get_contents() function is a widely used PHP built‑in that reads the entire contents of a file into a string, supporting local files, remote files, and URLs.

Syntax of file_get_contents()

<code>string file_get_contents(string $filename, bool $use_include_path = false, resource $context = null, int $offset = 0, int $maxlen = null)</code>

Parameters and Return Value

$filename : Path or URL of the file to read.

$use_include_path : Optional boolean; if true, the include_path is searched.

$context : Optional stream context resource for advanced operations.

$offset : Optional integer indicating the start position (default 0).

$maxlen : Optional integer limiting the number of bytes to read (default null, meaning the whole file).

The function returns the file contents as a string.

Usage Examples

1. Reading a Local File

Provide the file path as the first argument:

<code>&lt;?php
$filename = 'test.txt';
$file_content = file_get_contents($filename);
echo $file_content;
?&gt;</code>

2. Reading a Remote File

Pass the remote file URL:

<code>&lt;?php
$url = 'https://example.com/test.txt';
$file_content = file_get_contents($url);
echo $file_content;
?&gt;</code>

3. Reading a URL's HTML Content

Use the URL directly to fetch HTML:

<code>&lt;?php
$url = 'https://example.com';
$html = file_get_contents($url);
echo $html;
?&gt;</code>

4. Using a Stream Context for Advanced Requests

Create a context (e.g., to add HTTP headers) and pass it as the third argument:

<code>&lt;?php
$context = stream_context_create([
    'http' => [
        'header' => 'Authorization: Basic ' . base64_encode('username:password')
    ]
]);
$url = 'https://example.com';
$html = file_get_contents($url, false, $context);
echo $html;
?&gt;</code>

Summary

The file_get_contents() function offers a convenient way to read file data into a string, supporting various sources and optional parameters for include paths, offsets, length limits, and custom stream contexts, making it suitable for many backend PHP tasks.