概要
win_is_writable関数は、Windows環境で特定のファイルまたはディレクトリが書き込み可能かどうかをチェックするための関数です。主に次のような機能を実装する際によく使われます：
- プラグインが設定ファイルの書き込み権限を確認する際
- テーマの設定やキャッシュファイルの作成時にディレクトリの書き込み権限を確認する際
- アップロード機能を持つプラグインがアップロード先のディレクトリの確認を行う際
- バックアッププラグインがバックアップ先のディレクトリを確認する際
- セキュリティプラグインが特定のディレクトリの権限を検査する際
- ファイル操作を行うプラグインが書き込み可能か確認する際
- 自動更新機能が使用する一時ファイルの書き込み権限を確認する際
- インストーラーやセットアップ用のスクリプトが必要な権限をチェックする際
この関数は、WordPressのコアファイル wp-includes/functions.php に含まれています。
構文
win_is_writable( string $file )
パラメータ
$file(string) – チェックするファイルまたはディレクトリのパス。
戻り値
- boolean – 指定されたファイルまたはディレクトリが書き込み可能であれば
trueを、そうでなければfalseを返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 2.5以降で使用可能です。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数は、特定のバージョンで非推奨または削除されたことはありません。