PHP File Create/Write

PHP File Create/Write

This chapter covers how to create and write to files on the server using PHP.

Simplified File Writing with file_put_contents()

For many common scenarios, like creating a new file or overwriting an existing one with new content, the file_put_contents() function offers a simple and efficient approach. It’s often preferred over the lower-level fopen(), fwrite(), and fclose() combination for basic tasks.

This function handles opening, writing, and closing the file in one call. If the file doesn’t exist, it attempts to create it. If it does exist, it overwrites the content by default.

Example: Creating and writing to ‘myfile.txt’:

<?php
$file = 'myfile.txt';
// Content to write to the file
$content = "This is the first line.\nThis is the second line.\n";

// Write the contents to the file, overwriting the file if it exists.
// The function returns the number of bytes written on success, or false on failure.
if (file_put_contents($file, $content) !== false) {
    echo "File created and content written successfully.";
} else {
    echo "Error writing to file. Check permissions.";
}
?>

To append content instead of overwriting, use the FILE_APPEND flag:

<?php
$file = 'myfile.txt';
$new_content = "Appending this line.\n";

// Append content to the file
if (file_put_contents($file, $new_content, FILE_APPEND | LOCK_EX) !== false) {
    echo "Content appended successfully.";
} else {
    echo "Error appending to file. Check permissions.";
}
// LOCK_EX prevents others from writing to the file at the same time
?>

Advanced File Handling: fopen(), fwrite(), fclose()

For more control over file operations, such as reading line by line, working with specific file modes, or handling larger files more efficiently, the traditional fopen(), fwrite(), and fclose() functions are used.

PHP Create File - fopen()

The fopen() function is used to open a file or URL. If used with a write mode ('w', 'a', etc.) on a file that doesn’t exist, PHP will attempt to create it.

Common modes include:

• 'r' - Read only. Starts at the beginning of the file.
• 'w' - Write only. Opens and truncates the file to zero length or creates a new file if it doesn’t exist.
• 'a' - Append. Opens for writing only, placing the file pointer at the end. Creates the file if it doesn’t exist.
• 'x' - Create and open for writing only. Fails if the file already exists.
• Add '+' (e.g., 'r+', 'w+') to allow both reading and writing.

Example: Creating ‘testfile.txt’ using fopen():

<?php
$filename = "testfile.txt";
$mode = "w"; // Write mode: creates if not exists, truncates if exists

// fopen() returns a file pointer resource on success, or false on error.
$handle = fopen($filename, $mode);

if ($handle === false) {
    echo "Error: Unable to open or create file '{$filename}'. Check permissions.";
} else {
    echo "File '{$filename}' opened/created successfully.";
    // Remember to close the file handle when done
    fclose($handle);
}
?>

PHP Write to File - fwrite()

The fwrite() function writes the contents of a string to an open file pointer.

The first parameter is the file pointer resource (from fopen()), and the second is the string to write.

Example: Writing names to ‘newfile.txt’:

<?php
$filename = "newfile.txt";
$handle = fopen($filename, "w"); // Open in write mode

if ($handle) {
    $txt = "John Doe\n";
    fwrite($handle, $txt);

    $txt = "Jane Doe\n";
    fwrite($handle, $txt);

    fclose($handle); // Close the file
    echo "Data written to '{$filename}'.";
} else {
    echo "Error opening '{$filename}' for writing.";
}
?>

After running this code, ‘newfile.txt’ will contain:

John Doe
Jane Doe

PHP Overwriting vs. Appending

Opening a file in 'w' mode (write) will erase all existing content. If you want to add to the end of a file, use 'a' mode (append).

Example: Overwriting ‘newfile.txt’ using 'w' mode:

<?php
$filename = "newfile.txt";
$handle = fopen($filename, "w"); // 'w' mode truncates the file

if ($handle) {
    $txt = "Mickey Mouse\n";
    fwrite($handle, $txt);
    $txt = "Minnie Mouse\n";
    fwrite($handle, $txt);
    fclose($handle);
    echo "File '{$filename}' overwritten.";
} else {
    echo "Error opening '{$filename}' for writing.";
}
?>

Now ‘newfile.txt’ contains only:

Mickey Mouse
Minnie Mouse

PHP File Permissions

If you encounter errors when creating or writing files, it’s often due to file system permissions. The web server process (e.g., Apache, Nginx) running PHP needs permission to write to the directory where the script is trying to create or modify files. Consult your server documentation or hosting provider for details on managing permissions.

Complete PHP Filesystem Reference

For a complete reference of filesystem functions, refer to the official PHP documentation.