【PHP8.x】rmdir()関数の使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその中身（ファイル、サブディレクトリ）を再帰的に削除します。
5 *
6 * PHPのrmdir()は空のディレクトリしか削除できません。
7 * この関数は、まずディレクトリ内のすべてのファイルとサブディレクトリを削除してから、
8 * 最後に指定されたディレクトリ自体を削除します。
9 *
10 * @param string $dirPath 削除するディレクトリのパス
11 * @return bool すべての削除処理が成功した場合は true、それ以外は false
12 */
13function deleteDirectoryRecursively(string $dirPath): bool
14{
15    // ディレクトリが存在しない、またはディレクトリではない場合は処理を終了
16    if (!is_dir($dirPath)) {
17        return false;
18    }
19
20    // ディレクトリ内のアイテム（ファイル、サブディレクトリ）を取得
21    // scandirは '.' と '..' も返すため、これらは除外する
22    $items = array_diff(scandir($dirPath), ['.', '..']);
23
24    foreach ($items as $item) {
25        $itemPath = $dirPath . DIRECTORY_SEPARATOR . $item;
26        
27        // アイテムがディレクトリの場合は再帰的にこの関数を呼び出す
28        if (is_dir($itemPath)) {
29            if (!deleteDirectoryRecursively($itemPath)) {
30                return false; // サブディレクトリの削除に失敗した場合
31            }
32        } else {
33            // アイテムがファイルの場合はunlinkで削除
34            if (!unlink($itemPath)) {
35                return false; // ファイルの削除に失敗した場合
36            }
37        }
38    }
39
40    // 中身が空になったディレクトリをrmdirで削除
41    return rmdir($dirPath);
42}
43
44// --- 以下、サンプルコードの実行部分 ---
45
46// 1. テスト用のディレクトリとファイルを作成
47$targetDir = __DIR__ . '/test_directory';
48if (!file_exists($targetDir)) {
49    mkdir($targetDir, 0777, true);
50    mkdir($targetDir . '/sub_dir', 0777, true);
51    file_put_contents($targetDir . '/file1.txt', 'test');
52    file_put_contents($targetDir . '/sub_dir/file2.txt', 'test');
53    echo "テスト用のディレクトリを作成しました: " . $targetDir . PHP_EOL;
54}
55
56// 2. 作成した関数を呼び出して、ディレクトリをファイルごと削除
57echo "ディレクトリを削除します..." . PHP_EOL;
58if (deleteDirectoryRecursively($targetDir)) {
59    echo "ディレクトリの削除に成功しました。" . PHP_EOL;
60} else {
61    echo "ディレクトリの削除に失敗しました。" . PHP_EOL;
62}
63
64// 3. 削除されたかを確認
65if (!file_exists($targetDir)) {
66    echo "ディレクトリが存在しないことを確認しました。" . PHP_EOL;
67} else {
68    echo "ディレクトリがまだ存在します。" . PHP_EOL;
69}

PHPのrmdir関数は、指定されたパスのディレクトリを削除するために使用されます。引数として削除したいディレクトリのパスを文字列で受け取り、処理が成功すればtrueを、失敗すればfalseをブール値で返します。この関数の重要な点は、削除対象のディレクトリが完全に空である場合にのみ機能するという制約があることです。

提供されたサンプルコードでは、このrmdir関数の制約を補完し、ファイルやサブディレクトリを含むディレクトリ全体を再帰的に削除するdeleteDirectoryRecursively関数が実装されています。このカスタム関数は、まず指定されたディレクトリの中身をscandirで取得し、ファイルであればunlink関数で削除します。サブディレクトリが見つかった場合は、自身を再帰的に呼び出してそのサブディレクトリの中身を先に空にします。このようにして、ディレクトリ内のすべてのファイルとサブディレクトリを削除し終えてディレクトリが空になった後、最後にrmdir関数を使ってそのディレクトリ自体を削除します。これにより、rmdir単体ではできない、中身のあるディレクトリも安全かつまとめて削除する処理を実現しています。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容（サブディレクトリやファイル）を再帰的に削除します。
5 * rmdir() 関数は空のディレクトリしか削除できないため、この関数は空でないディレクトリを削除する際に役立ちます。
6 *
7 * @param string $dir 削除するディレクトリのパス。
8 * @return bool 削除が成功した場合は true、失敗した場合は false。
9 */
10function deleteDirectoryRecursive(string $dir): bool
11{
12    // ディレクトリが存在しない、またはディレクトリではない場合は失敗
13    if (!is_dir($dir)) {
14        return false;
15    }
16
17    // ディレクトリ内のすべてのファイルとサブディレクトリを取得
18    // scandir() は '.' (現在のディレクトリ) と '..' (親ディレクトリ) を含むため、これらを除外します。
19    $items = array_diff(scandir($dir), ['.', '..']);
20
21    foreach ($items as $item) {
22        // OSに依存しないパス区切り文字を使用してフルパスを構築
23        $path = $dir . DIRECTORY_SEPARATOR . $item;
24
25        if (is_dir($path)) {
26            // アイテムがディレクトリの場合、この関数を再帰的に呼び出して削除します。
27            if (!deleteDirectoryRecursive($path)) {
28                return false; // 再帰呼び出しで失敗した場合、全体の削除も失敗とします。
29            }
30        } else {
31            // アイテムがファイルの場合、unlink() で削除します。
32            if (!unlink($path)) {
33                return false; // ファイルの削除に失敗した場合、全体の削除も失敗とします。
34            }
35        }
36    }
37
38    // ディレクトリ内のすべてのコンテンツが削除されたら、空になったディレクトリ自体を rmdir() で削除します。
39    return rmdir($dir);
40}
41
42// --- 使用例 ---
43// このコードブロックを実行すると、一時的にディレクトリが作成され、その後削除されます。
44// 実際の動作を確認するには、コメントアウトされた 'echo' ステートメントを有効にするか、
45// スクリプト実行前後に手動でディレクトリの存在を確認してください。
46
47// 1. テスト用のディレクトリとファイルパスを定義
48$testBaseDir = __DIR__ . DIRECTORY_SEPARATOR . 'example_dir_to_delete';
49$testSubDir = $testBaseDir . DIRECTORY_SEPARATOR . 'sub_folder';
50$testFilePath1 = $testBaseDir . DIRECTORY_SEPARATOR . 'file_a.txt';
51$testFilePath2 = $testSubDir . DIRECTORY_SEPARATOR . 'file_b.txt';
52
53// 以前の実行で残ったディレクトリがあれば削除し、テストの冪等性を保ちます。
54if (is_dir($testBaseDir)) {
55    deleteDirectoryRecursive($testBaseDir);
56}
57
58// 2. テスト用のディレクトリ構造とファイルを作成
59// 0777 は開発環境でのみ推奨されるパーミッションです。本番環境では適切な権限を設定してください。
60mkdir($testBaseDir, 0777, true);
61mkdir($testSubDir, 0777, true);
62
63// ファイルに内容を書き込み、存在を確認できるようにします。
64file_put_contents($testFilePath1, 'Content for file A.');
65file_put_contents($testFilePath2, 'Content for file B.');
66
67// /*
68// // ディレクトリ作成後の状態を確認する例 (コメントアウトを解除して実行)
69// echo "--- 削除前のディレクトリ構造 ---\n";
70// if (is_dir($testBaseDir)) {
71//     echo $testBaseDir . " ディレクトリが存在します。\n";
72//     echo "内容:\n";
73//     // Windows環境の場合は 'dir /s /b' など適切なコマンドに変更してください
74//     system("ls -RF " . escapeshellarg($testBaseDir));
75// } else {
76//     echo $testBaseDir . " ディレクトリは存在しません。\n";
77// }
78// echo "------------------------------\n\n";
79// */
80
81// 3. 作成した空でないディレクトリを削除します。
82// rmdir() 関数だけでは空でないディレクトリは削除できないため、このカスタム関数を使用します。
83$deletionSuccess = deleteDirectoryRecursive($testBaseDir);
84
85// /*
86// // 削除結果を確認する例 (コメントアウトを解除して実行)
87// echo "--- 削除処理の結果 ---\n";
88// if ($deletionSuccess) {
89//     echo "ディレクトリ '{$testBaseDir}' の削除に成功しました。\n";
90//     if (!is_dir($testBaseDir)) {
91//         echo "削除後の確認: ディレクトリは存在しません。\n";
92//     } else {
93//         echo "エラー: 削除に成功したはずですが、ディレクトリがまだ存在します。\n";
94//     }
95// } else {
96//     echo "エラー: ディレクトリ '{$testBaseDir}' の削除に失敗しました。\n";
97//     if (is_dir($testBaseDir)) {
98//         echo "失敗後の確認: ディレクトリがまだ存在します。\n";
99//     }
100// }
101// echo "------------------------\n\n";
102// */
103
104// 4. 存在しないディレクトリを削除しようとする例
105// この場合、関数は false を返し、エラーなく終了します。
106$nonExistentDir = __DIR__ . DIRECTORY_SEPARATOR . 'non_existent_test_dir';
107$nonExistentResult = deleteDirectoryRecursive($nonExistentDir);
108
109// /*
110// // 存在しないディレクトリ削除の結果確認 (コメントアウトを解除して実行)
111// echo "--- 存在しないディレクトリ削除の結果 ---\n";
112// if (!$nonExistentResult) {
113//     echo "存在しないディレクトリ '{$nonExistentDir}' の削除は適切に失敗しました (期待される動作)。\n";
114// } else {
115//     echo "エラー: 存在しないディレクトリを削除しようとして予期せず成功しました。\n";
116// }
117// echo "--------------------------------------\n";
118// */

PHPのrmdir関数は、指定された空のディレクトリを削除する際に利用されます。この関数は、削除対象のディレクトリ内にファイルやサブディレクトリが存在する場合、エラーとなって削除できないという重要な制約を持っています。

提供されたサンプルコードは、このrmdir関数の制約を克服し、空でないディレクトリでも内容ごと再帰的に削除するためのdeleteDirectoryRecursiveというカスタム関数を示しています。この関数は、削除したいディレクトリのパスを文字列（string $dir）として引数に受け取り、削除処理の成否を真偽値（bool）で返します。

内部では、まず指定されたディレクトリが存在するかを確認し、存在しない場合はすぐにfalseを返します。次に、scandir関数などでディレクトリ内のすべてのファイルやサブディレクトリの一覧を取得し、一つずつ処理します。ファイルであればunlink関数で削除し、サブディレクトリであればdeleteDirectoryRecursive関数を再帰的に呼び出して、そのサブディレクトリの内容をすべて削除します。すべての内容が削除され、ディレクトリが空になった後に、最終的にrmdir関数を用いてその空になったディレクトリ自体を削除します。これにより、複雑なディレクトリ構造全体を安全かつ確実に削除することが可能になります。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリを削除しようと試み、その結果と失敗時の原因に関するヒントを報告します。
5 * rmdir() 関数が「動作しない」一般的なシナリオ（ディレクトリが存在しない、空ではない、
6 * パーミッションの問題など）に対応するための情報を提供し、システムエンジニアを目指す初心者にも
7 * 理解しやすいように設計されています。
8 *
9 * @param string $directoryPath 削除するディレクトリのパス。
10 * @return bool 削除が成功した場合はtrue、失敗した場合はfalse。
11 */
12function tryRemoveDirectory(string $directoryPath): bool
13{
14    echo "--- 試行: ディレクトリ '{$directoryPath}' の削除 ---\n";
15
16    // 1. ディレクトリが存在するかを事前に確認
17    if (!is_dir($directoryPath)) {
18        echo "エラー: ディレクトリ '{$directoryPath}' は存在しません。削除できませんでした。\n";
19        return false;
20    }
21
22    // 2. rmdir() を試行
23    // エラー抑制演算子 (@) を使用し、発生する可能性のある警告メッセージを非表示にします。
24    // 詳細なエラー情報は error_get_last() で後から取得します。
25    $result = @rmdir($directoryPath);
26
27    if ($result) {
28        echo "成功: ディレクトリ '{$directoryPath}' を削除しました。\n";
29        return true;
30    } else {
31        echo "失敗: ディレクトリ '{$directoryPath}' の削除に失敗しました。\n";
32
33        // rmdir() が失敗した場合のPHPの最後のエラーメッセージを取得
34        $lastError = error_get_last();
35        if ($lastError && $lastError['type'] === E_WARNING) {
36            echo "詳細エラー: " . $lastError['message'] . "\n";
37        }
38
39        echo "--- 失敗の一般的な原因と対処法ヒント ---\n";
40        echo "  1. ディレクトリが空ではない: rmdir() は空のディレクトリしか削除できません。\n";
41        echo "     削除したいディレクトリ内にファイルやサブディレクトリが残っていないか確認してください。\n";
42        echo "     空でないディレクトリを削除するには、先にその中身をすべて削除する必要があります。\n";
43        echo "  2. パーミッション不足: PHPを実行しているユーザーが、削除したいディレクトリの親ディレクトリに対し、\n";
44        echo "     書き込み権限（通常は 'w' または '7'）を持っているか確認してください。\n";
45        echo "     ファイルのパーミッションは chmod コマンドや FTP クライアントで変更できます。\n";
46        echo "  3. ディレクトリが使用中: 他のプロセスがこのディレクトリを開いている、または使用している可能性があります。\n";
47        echo "     関連するプロセスを終了してから再試行してください。\n";
48        echo "  4. ファイルシステムの問題: ディスクの破損やネットワークドライブの問題など、\n";
49        echo "     OSレベルでの問題が発生している可能性も考慮してください。\n";
50        return false;
51    }
52}
53
54// --- 単体で動作可能な使用例 ---
55
56// 1. 成功例: 存在する空のディレクトリを削除
57$successDir = __DIR__ . '/_test_empty_dir_to_delete';
58// ディレクトリが存在しない場合は作成
59if (!is_dir($successDir)) {
60    mkdir($successDir);
61    echo "テスト準備: 空のディレクトリ '{$successDir}' を作成しました。\n";
62}
63tryRemoveDirectory($successDir);
64echo "\n";
65
66// 2. 失敗例: 存在しないディレクトリを削除しようとする
67$nonExistentDir = __DIR__ . '/_non_existent_dir';
68tryRemoveDirectory($nonExistentDir);
69echo "\n";
70
71// 3. 失敗例: 空ではないディレクトリを削除しようとする
72$notEmptyDir = __DIR__ . '/_test_not_empty_dir';
73// ディレクトリが存在しない場合は作成し、ファイルを追加して空でない状態にする
74if (!is_dir($notEmptyDir)) {
75    mkdir($notEmptyDir);
76    file_put_contents($notEmptyDir . '/dummy_file.txt', 'This file makes the directory not empty.');
77    echo "テスト準備: 空ではないディレクトリ '{$notEmptyDir}' を作成しました。\n";
78}
79tryRemoveDirectory($notEmptyDir);
80
81// 失敗例3で作成したディレクトリとその中身をクリーンアップ
82// rmdir() は空でないディレクトリを削除できないため、手動で中身を削除してからディレクトリを削除します。
83if (is_dir($notEmptyDir)) {
84    if (file_exists($notEmptyDir . '/dummy_file.txt')) {
85        unlink($notEmptyDir . '/dummy_file.txt'); // ファイルを削除
86    }
87    rmdir($notEmptyDir); // 空になったディレクトリを削除
88    echo "クリーンアップ: '{$notEmptyDir}' とその中身を削除しました。\n";
89}
90echo "\n";
91
92// 4. 失敗例: パーミッション不足の可能性を示唆する例
93// 実際のパーミッション変更はシステムに影響を与える可能性があるため、コードには含めません。
94// tryRemoveDirectory関数内のヒントメッセージで対処法を説明します。
95$permissionHintDir = __DIR__ . '/_test_permission_hint_dir';
96if (!is_dir($permissionHintDir)) {
97    mkdir($permissionHintDir, 0755); // 通常の読み書き可能なパーミッションで作成
98    echo "テスト準備: ディレクトリ '{$permissionHintDir}' を作成しました。\n";
99}
100// このケースでは通常削除は成功しますが、パーミッションに関するヒントが重要です。
101tryRemoveDirectory($permissionHintDir);
102// クリーンアップ
103if (is_dir($permissionHintDir)) {
104    rmdir($permissionHintDir);
105    echo "クリーンアップ: '{$permissionHintDir}' を削除しました。\n";
106}
107echo "\n";

PHPのrmdir関数は、指定されたパスのディレクトリを削除するために使用されます。この関数は、引数として削除したいディレクトリのパス（string $directory）を受け取り、削除に成功すればtrue、失敗すればfalseをブール値で返します。オプションの?resource $context引数は、特定のストリームコンテキストを指定する場合に利用されます。

提供されたサンプルコードは、rmdir関数が「動作しない」と感じる一般的な状況とその対処法を、システムエンジニアを目指す初心者にも理解しやすいように解説しています。tryRemoveDirectory関数は、まず対象ディレクトリの存在をis_dir()で確認し、その後にrmdir関数を実行します。rmdirが失敗した場合、エラー抑制演算子@で抑制された警告メッセージの代わりに、error_get_last()で詳細なエラー情報を取得して表示します。

rmdirが失敗する主な原因は、「削除しようとしているディレクトリが空ではない」、「PHPを実行しているユーザーにディレクトリを削除するパーミッション（権限）がない」、または「ディレクトリが他のプロセスによって使用中」であることです。rmdir関数は空のディレクトリしか削除できないため、中身がある場合は事前にすべてのファイルやサブディレクトリを削除する必要があります。

サンプルコードには、成功するケースや、存在しないディレクトリ、空ではないディレクトリを削除しようとする失敗ケースなど、複数の具体的な使用例が含まれており、rmdirの挙動と、失敗時に確認すべきポイントや対処法を実践的に学ぶことができます。これにより、ディレクトリ削除のトラブルシューティングに役立つ知識が得られます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容を強制的に削除します。
5 * ディレクトリが空でなくても、その中のファイルやサブディレクトリを再帰的に削除し、
6 * 最終的に空になったディレクトリを削除します。
7 *
8 * rmdir() 関数は空のディレクトリしか削除できないため、
9 * この関数はその制約を克服し「強制的な削除」を実現します。
10 *
11 * @param string $directory 削除するディレクトリのパス
12 * @return bool 削除が成功した場合は true、失敗した場合は false
13 */
14function removeDirectoryRecursive(string $directory): bool
15{
16    // ディレクトリが存在しない場合、削除済みとみなし成功を返します
17    if (!is_dir($directory)) {
18        return true;
19    }
20
21    // ディレクトリの内容を読み込みます
22    $items = scandir($directory);
23
24    // ディレクトリの読み込みに失敗した場合
25    if ($items === false) {
26        error_log("Failed to read directory: " . $directory);
27        return false;
28    }
29
30    foreach ($items as $item) {
31        // カレントディレクトリと親ディレクトリへの参照はスキップします
32        if ($item === '.' || $item === '..') {
33            continue;
34        }
35
36        $path = $directory . DIRECTORY_SEPARATOR . $item;
37
38        if (is_dir($path)) {
39            // サブディレクトリの場合、この関数を再帰的に呼び出して削除します
40            if (!removeDirectoryRecursive($path)) {
41                error_log("Failed to remove subdirectory: " . $path);
42                return false; // サブディレクトリの削除に失敗
43            }
44        } else {
45            // ファイルの場合、unlink() 関数で削除します
46            if (!unlink($path)) {
47                error_log("Failed to remove file: " . $path);
48                return false; // ファイルの削除に失敗
49            }
50        }
51    }
52
53    // すべてのコンテンツが削除された後、空になったディレクトリを rmdir() 関数で削除します
54    // rmdir() は空のディレクトリのみ削除できます
55    if (!rmdir($directory)) {
56        error_log("Failed to remove empty directory: " . $directory);
57        return false; // 空になったディレクトリの削除に失敗
58    }
59
60    return true; // 成功
61}
62
63// --- サンプルコードの実行例 ---
64
65// テスト用のディレクトリを作成します
66$testBaseDir = 'test_forced_removal';
67$subDir1 = $testBaseDir . DIRECTORY_SEPARATOR . 'subdir1';
68$subDir2 = $subDir1 . DIRECTORY_SEPARATOR . 'subdir2';
69
70// 存在しない場合はディレクトリを作成
71if (!is_dir($testBaseDir)) {
72    mkdir($testBaseDir);
73}
74if (!is_dir($subDir1)) {
75    mkdir($subDir1);
76}
77if (!is_dir($subDir2)) {
78    mkdir($subDir2);
79}
80
81// テスト用のファイルを作成します
82file_put_contents($testBaseDir . DIRECTORY_SEPARATOR . 'file_in_root.txt', 'Root file content.');
83file_put_contents($subDir1 . DIRECTORY_SEPARATOR . 'file_in_subdir1.txt', 'Subdir1 file content.');
84file_put_contents($subDir2 . DIRECTORY_SEPARATOR . 'file_in_subdir2.txt', 'Subdir2 file content.');
85
86echo "テストディレクトリ構造を生成しました: " . realpath($testBaseDir) . "\n";
87echo "このディレクトリと内容を強制削除します。\n";
88
89// removeDirectoryRecursive() 関数を呼び出して強制削除を実行します
90if (removeDirectoryRecursive($testBaseDir)) {
91    echo "ディレクトリ '{$testBaseDir}' とその内容を正常に強制削除しました。\n";
92} else {
93    echo "ディレクトリ '{$testBaseDir}' の強制削除に失敗しました。\n";
94}
95
96// 削除後にディレクトリが存在しないことを確認します
97if (!is_dir($testBaseDir)) {
98    echo "検証: ディレクトリ '{$testBaseDir}' は現在存在しません。\n";
99} else {
100    echo "検証: エラー！ディレクトリ '{$testBaseDir}' がまだ存在します。\n";
101}
102

PHPのrmdir関数は、指定された「空の」ディレクトリを削除するために使用されます。この関数は、削除したいディレクトリのパスを文字列として受け取り、成功した場合はtrue、失敗した場合はfalseを返します。しかし、rmdir関数はディレクトリ内にファイルやサブディレクトリが存在すると削除できないという制約があります。システム運用において、内容の有無にかかわらずディレクトリを強制的に削除したい場面があるため、この制約を克服するカスタム関数が必要となります。

提供されたサンプルコードでは、removeDirectoryRecursiveという関数がその「強制削除」を実現しています。この関数は、指定されたディレクトリとその内容を再帰的に削除します。具体的には、まずディレクトリ内のファイルはunlink関数で、サブディレクトリは自身を再帰的に呼び出すことで削除し、最終的に空になったディレクトリをrmdir関数で削除します。removeDirectoryRecursive関数も、削除するディレクトリのパスを文字列で引数に取り、削除が成功した場合はtrue、失敗した場合はfalseを戻り値として返します。このような強力な削除機能を利用する際は、誤って重要なファイルを削除しないよう、十分な注意が必要です。