PHPプログラミングでよく使われるファイル・ディレクトリを操作する関数チートシート(システム開発・CMS構築など)

みなさんこんにちは!エンジニアの高澤です!
今回はPHPプログラミングでよく使われるファイル・ディレクトリを操作するための関数について解説していきたいと思います。
当記事では、PHPプログラミングしている中で「こんな関数もあったな?」というように予想がつくようにするためのスキル習得のための記事として構成しております。
ファイル・ディレクトリを操作するための関数が一覧でざっと目を通すことができるので、より詳しく知りたい関数があればPHPの公式ドキュメントなどでご確認いただくという形でご活用いただければと思います。
よろしければお仕事などでご活用ください。
目次
PHPとは
PHPとは、サーバーサイドで動作するスクリプト言語のことで、動的なWebページを作成する際に広く利用されています。
データベースとの連携やフォームの処理、セッション管理などが簡単に行えるため、WordPressやLaravelなどのCMSやフレームワークにも採用されています。
PHPの公式ドキュメントは以下になりますので、よろしければご確認ください。
ファイル・ディレクトリ操作系の関数とは
PHPには、ファイルやディレクトリを操作するための便利な組み込み関数が豊富に用意されています。
これらの関数を使うことで、ファイルの作成、読み取り、更新、削除、ディレクトリの管理などを効率的に行うことができます。CMS構築やファイル管理システムの開発に欠かせない重要な機能です。
ファイル・ディレクトリ操作系の関数一覧
それでは、ファイル・ディレクトリ操作系の関数一覧について掲載いたします。
ざっと目を通していただき、PHPでどんな関数があるのか把握していただくことで、PHPプログラミングしている中で「あ、そういえばこんな関数もあったな?」というように予想がつくようになります。
それだけでもエンジニアとしてのちゃんとしたスキルなので、当記事を通してご確認いただけましたら幸いです。
ファイルの読み書き
fopen
:ファイルを開くfclose
:ファイルを閉じるfread
:ファイルを読み込むfwrite
/fputs
:ファイルに書き込むfgets
:ファイルから1行読み込むfgetcsv
:CSV形式のファイルから1行読み込むfile_get_contents
:ファイルの内容を全て文字列として取得file_put_contents
:ファイルにデータを書き込むfseek
:ファイルポインタの位置を変更ftell
:現在のファイルポインタの位置を取得rewind
:ファイルポインタを先頭に戻すfeof
:ファイルポインタがEOF(ファイルの終端)に達したかチェックfflush
:出力バッファをファイルに書き出すflock
:ファイルへの排他的ロックをかけるftruncate
:ファイルを指定のサイズに切り詰める
ファイルの情報取得
file_exists
:ファイルやディレクトリが存在するか確認is_file
:指定したパスがファイルか確認is_dir
:指定したパスがディレクトリか確認is_readable
:ファイルが読み取り可能か確認is_writable
/is_writeable
:ファイルが書き込み可能か確認is_executable
:ファイルが実行可能か確認filesize
:ファイルのサイズを取得filetype
:ファイルの型を取得(例:file, dir, link)filemtime
:ファイルの最終更新時刻を取得filectime
:ファイルの作成時刻を取得fileatime
:ファイルの最終アクセス時刻を取得stat
:ファイルの詳細な情報を取得lstat
:シンボリックリンクを含めたファイル情報を取得pathinfo
:ファイルパスの情報(ディレクトリ名、ファイル名、拡張子)を取得basename
:ファイルの基本名(ファイル名)を取得dirname
:ファイルのディレクトリ名を取得realpath
:絶対パスを取得disk_free_space
:ディスクの空き容量を取得disk_total_space
:ディスクの総容量を取得- glob:パターンに一致するファイル一覧を取得
ファイルの削除・コピー・移動
unlink
:ファイルを削除copy
:ファイルをコピーrename
:ファイルやディレクトリの名前を変更move_uploaded_file
:アップロードされたファイルを移動
ファイルのパーミッションや所有者変更
chmod
:ファイルのパーミッション(権限)を変更chown
:ファイルの所有者を変更chgrp
:ファイルのグループを変更touch
:ファイルの作成日時や更新日時を変更umask
:新規ファイル作成時のパーミッションマスクを設定
ディレクトリ操作
mkdir
:ディレクトリを作成rmdir
:ディレクトリを削除opendir
:ディレクトリを開くreaddir
:ディレクトリ内のファイルやディレクトリ名を読み込むclosedir
:ディレクトリを閉じるscandir
:ディレクトリ内のファイルやディレクトリ名を一覧で取得chdir
:カレントディレクトリを変更getcwd
:現在のカレントディレクトリを取得dir
:ディレクトリのストリームオブジェクトを取得
ファイルシステム関連
tempnam
:一時ファイルの名前を生成tmpfile
:一時ファイルを作成readfile
:ファイルの内容を出力するlink
:ハードリンクを作成symlink
:シンボリックリンクを作成readlink
:シンボリックリンクの内容を取得unlink
:シンボリックリンクを削除
ファイルアップロード関連
is_uploaded_file
:指定ファイルがHTTP経由でアップロードされたか確認move_uploaded_file
:アップロードされたファイルを新しい場所に移動
ファイルポインタとストリーム関連
fopen
/popen
:ファイルやプロセスを開くfclose
:ファイルを閉じるstream_get_contents
:ストリームからデータを読み込むstream_context_create
:ストリームコンテキストを作成stream_copy_to_stream
:ストリーム間でデータをコピーstream_filter_append
:ストリームにフィルタを適用stream_set_timeout
:ストリームのタイムアウトを設定stream_wrapper_register
:カスタムプロトコルハンドラを登録
ファイル読み込み
include
/require
:ファイルを読み込むinclude_once
/require_once
:ファイルを1回だけ読み込むdefined
:定数が定義されているか確認define
:定数を定義
まとめ
今回は、PHPプログラミングでよく使用されるファイル・ディレクトリ操作の関数について解説しました。
この記事では、PHPでファイルやディレクトリを操作するための便利な関数をざっと確認することができました。「こんな関数もあったな」と思い出し、スキルの習得に役立てていただけたかと思います。
もしさらに詳細な情報が必要な場合は、PHPの公式ドキュメントを参照してください。
これらの関数は、実際の開発やお仕事で役立つ場面が多いため、ぜひ覚えて活用してみてください。
お気軽に皆さんのご要望をお聞かせください!
どんなに些細なことでも構いません!よろしければ記事や当サイトへの「こんな記事があったら仕事とかで役に立つな〜」や「こうだったらもっと役に立つのに!」といったようなご要望等をお気軽にお聞かせください!今後のサービス改善にお役立てさせていただきます!
例1)Reactの技術記事を書いてほしい!
例2)WordPressの使い方とかを初心者向けに解説してほしい!...など