【PHP8.x】unlink関数の使い方

Copy
1<?php
2
3/**
4 * PHPのunlink関数を使用してファイルを安全に削除するサンプルコードです。
5 * unlink関数はファイルのみを削除できます。ディレクトリの削除には使用できません。
6 * ディレクトリ内のファイルを削除するシナリオを想定しています。
7 */
8function demonstrateUnlinkFunction(): void
9{
10    // 削除対象のファイルを作成する一時ディレクトリを準備します。
11    // sys_get_temp_dir() でOSの一時ディレクトリパスを取得し、
12    // DIRECTORY_SEPARATOR でOSに応じたパス区切り文字を使用します。
13    $tempDirectory = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_unlink_example_' . uniqid();
14    
15    // ディレクトリが存在しない場合は作成します。
16    if (!mkdir($tempDirectory, 0777, true)) {
17        echo "エラー: 一時ディレクトリ '{$tempDirectory}' の作成に失敗しました。\n";
18        return;
19    }
20    echo "一時ディレクトリを作成しました: {$tempDirectory}\n";
21
22    $fileName = "delete_me.txt";
23    $filePath = $tempDirectory . DIRECTORY_SEPARATOR . $fileName;
24
25    // 削除対象となるファイルを準備します。
26    // file_put_contents() でファイルに内容を書き込み、ファイルを作成します。
27    if (file_put_contents($filePath, "このファイルはunlink関数によって削除されます。\n") === false) {
28        echo "エラー: ファイル '{$filePath}' の作成に失敗しました。\n";
29        // ファイル作成失敗時は、作成したディレクトリを削除してクリーンアップします。
30        rmdir($tempDirectory);
31        return;
32    }
33    echo "ファイルを作成しました: {$filePath}\n";
34
35    // ファイルが作成されたことを確認します。
36    if (file_exists($filePath)) {
37        echo "ファイル '{$filePath}' が存在します。削除を試みます。\n";
38
39        // unlink関数を使ってファイルを削除します。
40        // 第1引数: 削除するファイルのパス (string)
41        // 第2引数: オプションでストリームコンテキストを指定できますが、通常はnullで十分です。
42        if (unlink($filePath)) {
43            echo "ファイルを正常に削除しました: {$filePath}\n";
44        } else {
45            // 権限の問題などで削除に失敗する場合があります。
46            echo "エラー: ファイル '{$filePath}' の削除に失敗しました。\n";
47        }
48    } else {
49        echo "エラー: 削除しようとしたファイル '{$filePath}' が見つかりません。\n";
50    }
51
52    // 削除後、ファイルが存在しないことを確認します。
53    if (!file_exists($filePath)) {
54        echo "ファイルは現在、存在しません。\n";
55    }
56
57    // 最後に、作成した一時ディレクトリをクリーンアップします。
58    // unlinkはファイルを削除する関数であり、ディレクトリは削除できません。
59    // rmdir関数は空のディレクトリを削除するために使用します。
60    // scandirの結果が '.' と '..' のみの場合、ディレクトリは空と判断できます。
61    if (is_dir($tempDirectory) && count(scandir($tempDirectory)) === 2) {
62        if (rmdir($tempDirectory)) {
63            echo "一時ディレクトリ '{$tempDirectory}' を削除しました。\n";
64        } else {
65            echo "注意: 一時ディレクトリ '{$tempDirectory}' の削除に失敗しました。\n";
66        }
67    } else {
68        echo "注意: 一時ディレクトリ '{$tempDirectory}' が空ではないため削除できませんでした。手動で確認してください。\n";
69    }
70}
71
72// 関数の実行
73demonstrateUnlinkFunction();
74

PHP 8のunlink関数は、ファイルシステムから指定されたファイルを削除するための基本的な関数です。この関数は、プログラムから不要なファイルを削除する際に利用されます。

第一引数$filenameには、削除したいファイルの完全なパスを文字列として渡します。もしファイルが存在しない場合や、PHPスクリプトにファイルを削除する適切な権限がない場合などには、削除に失敗します。第二引数$contextはオプションで、ストリームコンテキストを指定する際に使用しますが、通常は省略可能です。関数がファイルの削除に成功した場合はtrueを返し、何らかの理由で失敗した場合はfalseを返します。

特に重要な点として、unlink関数はファイルのみを対象とし、ディレクトリ（フォルダ）を削除することはできません。もしディレクトリを削除しようとすると、エラーが発生します。サンプルコードでは、一時ディレクトリを作成し、その中に一時的なファイルを作成した後、unlink関数を使ってそのファイルを削除する手順を具体的に示しています。ファイルの削除後、作成したディレクトリはrmdir関数を使ってクリーンアップしており、ファイルとディレクトリの削除には異なる関数が必要であることが理解できます。

Copy
1<?php
2
3/**
4 * 指定されたファイルを安全に削除します。
5 * ファイルが存在しない場合は削除を試みず、その旨を通知します。
6 *
7 * @param string $filename 削除するファイルのパス
8 * @return void
9 */
10function safeUnlink(string $filename): void
11{
12    echo "--- ファイル削除処理: {$filename} ---\n";
13
14    // 削除対象のファイルが存在するかどうかを確認します。
15    if (file_exists($filename)) {
16        echo "ファイル '{$filename}' は存在します。削除を試みます...\n";
17        
18        // ファイルが存在する場合、unlink関数で削除を試みます。
19        // unlink関数は成功した場合に true、失敗した場合に false を返します。
20        if (unlink($filename)) {
21            echo "ファイル '{$filename}' の削除に成功しました。\n";
22        } else {
23            // 削除に失敗した場合、エラーメッセージを出力します。
24            // 権限不足などが原因で失敗することがあります。
25            echo "エラー: ファイル '{$filename}' の削除に失敗しました。\n";
26        }
27    } else {
28        // ファイルが存在しない場合、unlink関数を呼び出す必要がないことを通知します。
29        // 存在しないファイルに対してunlinkを呼び出すと、E_WARNINGが発生し、falseが返されます。
30        echo "ファイル '{$filename}' は存在しません。削除処理をスキップします。\n";
31    }
32    echo "\n";
33}
34
35// --- 実際の使用例 ---
36
37// 1. 存在しないファイルを削除しようとするケース
38$nonExistentFile = __DIR__ . '/non_existent_example.txt';
39safeUnlink($nonExistentFile);
40
41// 2. 存在するファイルを削除しようとするケース
42$existentFile = __DIR__ . '/existent_example.txt';
43
44// テスト用にファイルを事前に作成します。
45file_put_contents($existentFile, 'このファイルはテスト用に作成され、削除されます。');
46echo "テスト用にファイル '{$existentFile}' を作成しました。\n\n";
47
48safeUnlink($existentFile);
49
50// 3. (再度) 既に削除されたファイルを削除しようとするケース
51//    これは1番目のケースと同じ結果になります。
52safeUnlink($existentFile);
53
54?>

PHPのunlink関数は、ファイルシステムから指定されたファイルを削除するために使用します。第一引数の$filenameには削除したいファイルのパスを文字列で指定し、第二引数の$contextは高度な用途で使用されるため通常は省略します。この関数は、ファイルの削除に成功した場合はtrueを、失敗した場合はfalseをブール値で返します。

特に注意が必要なのは、存在しないファイルに対してunlink関数を直接呼び出すと、PHPが警告（E_WARNING）を発出し、戻り値はfalseとなる点です。これを避けてより安全にファイルを削除するために、サンプルコードのsafeUnlink関数のアプローチが推奨されます。

safeUnlink関数は、まずfile_exists()関数を使って削除対象のファイルが存在するかどうかを事前に確認します。ファイルが存在する場合のみunlink関数を呼び出し、その成否に応じて適切なメッセージを表示します。ファイルが存在しない場合はunlinkの呼び出し自体をスキップし、ファイルが存在しない旨を通知することで、不要な警告の発生を防ぎ、堅牢なファイル削除処理を実現しています。