WP_Filesystem()


WordPressのWP_Filesystem()関数は、ファイルシステム操作を安全に行うためのラッパーとして機能します。

シンタックス

WP_Filesystem( mixed $args = '', string $context = '', bool $allow_relaxed_file_ownership = false );

引数の説明:

  • $args (mixed) — 接続に使用するパラメータ。通常は空のままにします。
  • $context (string) — 操作するディレクトリのパスを指定します。
  • $allow_relaxed_file_ownership (bool) — ファイル所有権チェックを緩和する場合はtrueを指定します。

使用例

例 1: ファイルシステムの初期化

ファイル操作を開始するには、ファイルシステムを初期化する必要があります。

<?php
if ( ! function_exists( 'WP_Filesystem' ) ) {
    require_once ABSPATH . 'wp-admin/includes/file.php';
}
WP_Filesystem();
?>

例 2: ファイルの内容を取得

特定のファイルから内容を取得するコード例です。

<?php
global $wp_filesystem;
WP_Filesystem();
$content = $wp_filesystem->get_contents( get_template_directory() . '/sample.txt' );
echo $content;
?>

例 3: ファイルの作成

新しいファイルを作成し、内容を書き込む例です。

<?php
global $wp_filesystem;
WP_Filesystem();
$wp_filesystem->put_contents( get_template_directory() . '/newfile.txt', '新しいファイルの内容です。' );
?>

例 4: ファイルの削除

指定したファイルを削除する例です。

<?php
global $wp_filesystem;
WP_Filesystem();
$wp_filesystem->delete( get_template_directory() . '/unnecessary.txt' );
?>

例 5: ディレクトリの作成

新しいディレクトリを作成する例です。

<?php
global $wp_filesystem;
WP_Filesystem();
$wp_filesystem->mkdir( get_template_directory() . '/new-directory' );
?>

注意事項

  • WP_Filesystem()を使用する場合、グローバル変数$wp_filesystemを有効にする必要があります。
  • 権限の確認を忘れないでください。特にファイルやディレクトリへの書き込み操作では、適切なアクセス権が必要です。

関連機能：