概要
wp_is_writable関数は、指定されたディレクトリやファイルが書き込み可能かどうかを判定するために使用されるWordPressの関数です。この関数は、ディレクトリが書き込みできるか調べる場合に特に役立ちます。例えば、プラグインやテーマのインストールや設定変更、ファイルのアップロードやキャッシュの生成時などで用いられます。以下は、wp_is_writableがよく使われる機能の例です：
- プラグインのインストール
- テーマのアップデート
- キャッシュファイルの生成
- アップロードフォルダのチェック
- パーミッションの確認
- 設定ファイルの編集
- ログファイルの書き込み
- ユーザーアップロードの管理
構文
wp_is_writable( string $filename )
パラメータ
filename: チェックしたいファイルまたはディレクトリのパス（必須）。
戻り値
true：指定されたファイルまたはディレクトリが書き込み可能な場合。false：書き込みができない場合。
関連する関数
使用可能なバージョン
- 有効なバージョン: 2.5以降
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
- 非推奨または削除されたバージョン: 特になし
サンプルコード
サンプルコード 1
$path = '/path/to/directory';
if ( wp_is_writable( $path ) ) {
echo 'ディレクトリは書き込み可能です。';
} else {
echo 'ディレクトリは書き込みできません。';
}
このサンプルコードは、指定したパスにあるディレクトリが書き込み可能かチェックし、その結果に応じてメッセージを表示します。
サンプルコード 2
$file = '/path/to/file.txt';
if ( wp_is_writable( $file ) ) {
// ファイルにデータを書き込む処理
} else {
// エラーハンドリング
}
このサンプルでは、指定したファイルが書き込み可能かどうかをチェックし、書き込める場合は特定の処理を実行します。
サンプルコード 3
$uploads_dir = wp_upload_dir()['basedir'];
if ( ! wp_is_writable( $uploads_dir ) ) {
wp_die( 'アップロードディレクトリが書き込み可能ではありません。' );
}
このサンプルコードは、WordPressのアップロードディレクトリが書き込み可能でない場合、エラーメッセージを表示して処理を中止します。
サンプルコード 4
$log_file = '/path/to/log.txt';
if ( ! wp_is_writable( $log_file ) ) {
error_log('ログファイルが書き込みできません。');
}
このコードは、ログファイルが書き込み不能な場合にエラーログにメッセージを記録します。
サンプルコード 5
if ( wp_is_writable( WP_CONTENT_DIR ) ) {
// コンテンツディレクトリに対しての処理
} else {
echo 'コンテンツディレクトリは書き込み不可です。';
}
このサンプルでは、WordPressコンテンツディレクトリが書き込み可能かどうかをチェックし、その結果に応じた処理を行います。