【PHP8.x】is_readable関数の使い方
作成日: 更新日:
is_readable関数は、指定されたファイルまたはディレクトリが現在のPHPスクリプトから読み込み可能であるかを確認する関数です。この関数は、プログラムが特定のファイルの内容を読み取ったり、ディレクトリ内の情報を取得したりする前に、その操作が実際に可能であるかを判断するために使用されます。
引数として、確認したいファイルまたはディレクトリへのパスを文字列で指定します。指定されたパスが読み込み可能であると判断されればブール値のtrue
を返し、読み込み不可能であればfalse
を返します。「読み込み可能」とは、単にファイルやディレクトリが存在するだけでなく、PHPスクリプトを実行しているサーバーユーザーが、その対象に対する読み込み権限を適切に持っている状態を意味します。
ファイル操作を行うアプリケーションを開発する際には、file_get_contents()
などの実際のファイル読み込み処理を実行する前にis_readable()
で権限を事前にチェックすることが非常に有効です。これにより、存在しないファイルや権限のないファイルへのアクセス試行によるエラーや警告を未然に防ぎ、より堅牢で安定したプログラムを構築することができます。ファイルが存在するかどうかだけを確認したい場合はfile_exists()
関数も利用できますが、is_readable()
は存在確認に加えて、実質的な読み込み権限の有無まで確認する点で異なります。この関数はPHP 8環境で利用可能です。
基本的な使い方
構文(syntax)
<?php
$filepath = 'path/to/your/file.txt'; // 読み込み可能か確認したいファイルのパス
$isReadable = is_readable($filepath); // ファイルが読み込み可能であれば true、そうでなければ false を返す
?>
引数(parameters)
string $filename
- string $filename: 読み込み可能かどうかを確認したいファイルパスを指定する文字列
戻り値(return)
bool
指定されたファイルパスのファイルまたはディレクトリが読み取り可能である場合に true
を、そうでない場合に false
を返します。