PHP Reference
Tags:
Categories: , ,

Quick Reference

The PHP file_put_contents() writes data to a file.

This function follows these rules when accessing a file:

  • If FILE_USE_INCLUDE_PATH is set, check the include path for a copy of filename
  • Create the file if it does not exist
  • Open the file
  • Lock the file if LOCK_EX is set
  • If FILE_APPEND is set, move to the end of the file. Otherwise, clear the file content
  • Write the data into the file
  • Close the file and release any locks
<?php
echo file_put_contents('test.txt', 'Hello World!');
?>

Output

// writes data to a file

Syntax

file_put_contents(filename, data, mode, context)

Parameters

ParameterDescription
filenameSpecifies the path to the file to write to; if the file does not exist, this function will create one (required)
dataThe data to write to the file
modeSpecifies how to open/write to the file:

  • FILE_USE_INCLUDE_PATH - search for filename in the include directory

  • FILE_APPEND - if file already exists, append the data to it - instead of overwriting it

  • LOCK_EX - Put an exclusive lock on the file while writing to it
contextSpecifies the context of the file handle; context is a set of options that can modify the behavior of a stream

PHP Notes:

  • When using PHP, single or double quotation marks are acceptable and work identically to one another; choose whichever you prefer, and stay consistent
  • Arrays count starting from zero NOT one; so item 1 is position [0], item 2 is position [1], and item 3 is position [2] … and so on
If you like our content, and find it helpful, please consider making a small donation. Thank you!

We’d like to acknowledge that we learned a great deal of our coding from W3Schools and TutorialsPoint, borrowing heavily from their teaching process and excellent code examples. We highly recommend both sites to deepen your experience, and further your coding journey. We’re just hitting the basics here at 1SMARTchicken.