PHP file_get_contents() Function

Definition

file_get_contents() takes the filename to open. It returns the contents of the file as a string, complete with new line characters \n where appropriate.

The file_get_contents() reads a file into a string.

Syntax

PHP file_get_contents() Function has the following syntax.

file_get_contents(path,include_path,context,start,max_length)

Parameter

ParameterIs RequiredDescription
pathRequired.File to read
include_pathOptional.Set to '1' to search for the file in the include_path defined in php.ini
contextOptional.Context of the file handle. Context is a set of options that can modify the behavior of a stream. Can be skipped by using NULL.
startOptional.Where in the file to start reading.
max_lengthOptional.How many bytes to read.

Return

The function returns the read data or FALSE on failure.

Note

This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE.

Use the === operator for testing the return value of this function.

Example


<?PHP/*from w  w  w.j ava 2s.  co  m*/
      $filename = "test.txt";
      $filestring = file_get_contents($filename);
      if ($filestring) {
             print $filestring;
      } else {
             print "Could not open $filename.\n";
      }
      
      echo file_get_contents("test.txt");
?>

The code above generates the following result.





















Home »
  PHP Tutorial »
    Function reference »




PHP Array Functions
PHP Calendar Functions
PHP Class Functions
PHP Data Type Functions
PHP Date Functions
PHP File Functions
PHP Image Functions
PHP Math Functions
PHP MySQLi Functions
PHP SimpleXML Functions
PHP String Functions
PHP XML Functions
PHP Zip Functions