PHP: file_get_contents - Manual Downloads Documentation Get Involved Help PHP Conference Odawara 2024 Getting Started Introduction A simple tutorial Language Reference Basic syntax Types Variables Constants Expressions Operators Control Structures Functions Classes and Objects Namespaces Enumerations Errors Exceptions Fibers Generators Attributes References Explained Predefined Variables Predefined Exceptions Predefined Interfaces and Classes Predefined Attributes Context options and parameters Supported Protocols and Wrappers Security Introduction General considerations Installed as CGI binary Installed as an Apache module Session Security Filesystem Security Database Security Error Reporting User Submitted Data Hiding PHP Keeping Current Features HTTP authentication with PHP Cookies Sessions Dealing with XForms Handling file uploads Using remote files Connection handling Persistent Database Connections Command line usage Garbage Collection DTrace Dynamic Tracing Function Reference Affecting PHP's Behaviour Audio Formats Manipulation Authentication Services Command Line Specific Extensions Compression and Archive Extensions Cryptography Extensions Database Extensions Date and Time Related Extensions File System Related Extensions Human Language and Character Encoding Support Image Processing and Generation Mail Related Extensions Mathematical Extensions Non-Text MIME Output Process Control Extensions Other Basic Extensions Other Services Search Engine Extensions Server Specific Extensions Session Extensions Text Processing Variable and Type Related Extensions Web Services Windows Only Extensions XML Manipulation GUI Extensions Keyboard Shortcuts? This help j Next menu item k Previous menu item g p Previous man page g n Next man page G Scroll to bottom g g Scroll to top g h Goto homepage g s Goto search(current page) / Focus search box file_put_contents » « file_exists PHP Manual Function Reference File System Related Extensions Filesystem Filesystem Functions Change language: English Brazilian Portuguese Chinese (Simplified) French German Japanese Russian Spanish Turkish Other Submit a Pull Request Report a Bug file_get_contents (PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)file_get_contents — Reads entire file into a string Description file_get_contents(    string $filename,    bool $use_include_path = false,    ?resource $context = null,    int $offset = 0,    ?int $length = null): string|false This function is similar to file(), except that file_get_contents() returns the file in a string, starting at the specified offset up to length bytes. On failure, file_get_contents() will return false. file_get_contents() is the preferred way to read the contents of a file into a string. It will use memory mapping techniques if supported by your OS to enhance performance. Note: If you're opening a URI with special characters, such as spaces, you need to encode the URI with urlencode(). Parameters filename Name of the file to read. use_include_path Note: The FILE_USE_INCLUDE_PATH constant can be used to trigger include path search. This is not possible if strict typing is enabled, since FILE_USE_INCLUDE_PATH is an int. Use true instead. context A valid context resource created with stream_context_create(). If you don't need to use a custom context, you can skip this parameter by null. offset The offset where the reading starts on the original stream. Negative offsets count from the end of the stream. Seeking (offset) is not supported with remote files. Attempting to seek on non-local files may work with small offsets, but this is unpredictable because it works on the buffered stream. length Maximum length of data read. The default is to read until end of file is reached. Note that this parameter is applied to the stream processed by the filters. Return Values The function returns the read data or false on failure. WarningThis function may return Boolean false, but may also return a non-Boolean value which evaluates to false. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function. Errors/Exceptions An E_WARNING level error is generated if filename cannot be found, length is less than zero, or if seeking to the specified offset in the stream fails. When file_get_contents() is called on a directory, an E_WARNING level error is generated on Windows, and as of PHP 7.4 on other operating systems as well. Changelog Version Description 8.0.0 length is nullable now. 7.1.0 Support for negative offsets has been added. Examples Example #1 Get and output the source of the homepage of a website <?php$homepage = file_get_contents('http://www.example.com/');echo $homepage;?> Example #2 Searching within the include_path <?php// If strict types are enabled i.e. declare(strict_types=1);$file = file_get_contents('./people.txt', true);// Otherwise$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);?> Example #3 Reading a section of a file <?php// Read 14 characters starting from the 21st character$section = file_get_contents('./people.txt', FALSE, NULL, 20, 14);var_dump($section);?> The above example will output something similar to: string(14) "lle Bjori Ro" Example #4 Using stream contexts <?php// Create a stream$opts = array( 'http'=>array( 'method'=>"GET", 'header'=>"Accept-language: en\r\n" . "Cookie: foo=bar\r\n" ));$context = stream_context_create($opts);// Open the file using the HTTP headers set above$file = file_get_contents('http://www.example.com/', false, $context);?> Notes Note: This function is binary-safe. TipA URL can be used as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename. See the Supported Protocols and Wrappers for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide. WarningWhen using SSL, Microsoft IIS will violate the protocol by closing the connection without sending a close_notify indicator. PHP will report this as "SSL: Fatal Protocol Error" when you reach the end of the data. To work around this, the value of error_reporting should be lowered to a level that does not include warnings. PHP can detect buggy IIS server software when you open the stream using the https:// wrapper and will suppress the warning. When using fsockopen() to create an ssl:// socket, the developer is responsible for detecting and suppressing this warning. See Also file() - Reads entire file into an array fgets() - Gets line from file pointer fread() - Binary-safe file read readfile() - Outputs a file file_put_contents() - Write data to a file stream_get_contents() - Reads remainder of a stream into a string stream_context_create() - Creates a stream context $http_response_header ＋add a note User Contributed Notes 8 notes up down 31 Bart Friederichs ¶11 years ago file_get_contents can do a POST, create a context for that first: <?php $opts = array('http' => array( 'method' => 'POST', 'header' => "Content-Type: text/xml\r\n". "Authorization: Basic ".base64_encode("$https_user:$https_password")."\r\n", 'content' => $body, 'timeout' => 60 ) ); $context = stream_context_create($opts); $url = 'https://'.$https_server; $result = file_get_contents($url, false, $context, -1, 40000); ?> up down 0 KC ¶1 month ago If doing a negative offset to grab the end of a file and the file is shorter than the offset, then file_get_contents( ) will return false.If you want it to just return what is available when the file is shorter than the negative offset, you could try again.For example...$contents = file_get_contents( $log_file, false, null, -4096 ); // Get last 4KBif ( false === $contents ) { // Maybe error, or maybe file less than 4KB in size. $contents = file_get_contents( $log_file, false, null ); if ( false === $contents ) { // Handle real error. }} up down 0 brentcontact at daha dot us ¶5 months ago To prevent mixed content most browsers/functions will use the protocol already used if you specify only // instead of http:// or https://. This is not the case with file_get_contents. You must specify the protocol. This does not work:<?php$jsonData = file_get_contents('//example.com/file.json');print $jsonData;?>Specifying only 'example.com/file.json' without the double slash does not work either.When running on Apache 2.4 , using $_SERVER['REQUEST_SCHEME'] is a better way to be protocol agnostic.<?php$jsonData = file_get_contents($_SERVER['REQUEST_SCHEME'].'://example.com/file.json');print $jsonData;?>If using another web server, you may have to get the protocol another way or hard code it. up down 0 daniel at dangarbri dot tech ¶10 months ago Note that if an HTTP request fails but still has a response body, the result is still false, Not the response body which may have more details on why the request failed. up down -2 soger ¶1 year ago There's barely a mention on this page but the $http_response_header will be populated with the HTTP headers if your file was a link. For example if you're expecting an image you can do this:<?php$data = file_get_contents('https://example.net/some-link');$mimetype = null;foreach ($http_response_header as $v) { if (preg_match('/^content\-type:\s*(image\/[^;\s\n\r]+)/i', $v, $m)) { $mimetype = $m[1]; }}if (!$mimetype) { // not an image} up down -22 Anonymous ¶2 years ago if the connection iscontent-encoding: gzipand you need to manually ungzip it, this is apparently the key$c=gzinflate( substr($c,10,-8) );(stolen from the net) up down -24 453034559 at qq dot com ¶2 years ago //从指定位置获取指定长度的文件内容function file_start_length($path,$start=0,$length=null){ if(!file_exists($path)) return false; $size=filesize($path); if($start<0) $start+=$size; if($length===null) $length=$size-$start; return file_get_contents($path, false, null, $start, $length );} up down -29 allenmccabe at gmail dot com ¶2 years ago I'm not sure why @jlh was downvoted, but I verified what he reported.>>> file_get_contents($path false, null, 5, null)=> "">>> file_get_contents($path, false, null, 5, 5)=> "r/bin" ＋add a note Filesystem Functions basename chgrp chmod chown clearstatcache copy delete dirname disk_​free_​space disk_​total_​space diskfreespace fclose fdatasync feof fflush fgetc fgetcsv fgets fgetss file_​exists file_​get_​contents file_​put_​contents file fileatime filectime filegroup fileinode filemtime fileowner fileperms filesize filetype flock fnmatch fopen fpassthru fputcsv fputs fread fscanf fseek fstat fsync ftell ftruncate fwrite glob is_​dir is_​executable is_​file is_​link is_​readable is_​uploaded_​file is_​writable is_​writeable lchgrp lchown link linkinfo lstat mkdir move_​uploaded_​file parse_​ini_​file parse_​ini_​string pathinfo pclose popen readfile readlink realpath_​cache_​get realpath_​cache_​size realpath rename rewind rmdir set_​file_​buffer stat symlink tempnam tmpfile touch umask unlink Copyright © 2001-2024 The PHP Group My PHP.net Contact Other PHP.net sites Privacy policy