Введение в API файловой системы WordPress

 function menu_item() { add_submenu_page("options-general.php", "Demo", "Demo", "manage_options", "demo", "demo_page"); } add_action("admin_menu", "menu_item"); function demo_page() { ?> <div class="wrap"> <h1>Demo</h1> <form method="post"> <?php $output = ""; if(isset($_POST["file-data"])) { $output = write_file_demo($_POST["file-data"]); } else { $output = read_file_demo(); } if(!is_wp_error($output)) { ?> <textarea name="file-data"><?php echo $output; ?></textarea> <?php wp_nonce_field("filesystem-nonce"); ?> <br> <input type="submit"> <?php } else { echo $output->get_error_message(); } ?> </form> </div> <?php } 

Вот как работает код:

• Сначала мы добавили страницу в меню «Настройки». demo_page — это обратный вызов для отображения содержимого страницы.
• Внутри страницы мы отображаем HTML-форму с полями textarea и nonce. Также есть кнопка отправки для отправки формы. Имя текстовой области — file-data . Одноразовый номер добавлен для предотвращения атаки CSRF .
• Когда страница открыта, мы read_file_demo данные сохраненного файла с read_file_demo функции read_file_demo . Когда форма отправлена, мы сохраняем содержимое текстовой области в файл, используя функцию write_file_demo .
• Если read_file_demo или write_file_demo возвращает экземпляр объекта WP_Error , вместо этого мы отобразим сообщение об ошибке.

Обратите внимание, что приведенный выше код сломает ваш сайт WordPress, так как мы еще не создали функции read_file_demo и write_file_demo . Давайте создадим их сейчас!

Запись в файл

Вот реализация нашей функции write_file_demo :

 function connect_fs($url, $method, $context, $fields = null) { global $wp_filesystem; if(false === ($credentials = request_filesystem_credentials($url, $method, false, $context, $fields))) { return false; } //check if credentials are correct or not. if(!WP_Filesystem($credentials)) { request_filesystem_credentials($url, $method, true, $context); return false; } return true; } function write_file_demo($text) { global $wp_filesystem; $url = wp_nonce_url("options-general.php?page=demo", "filesystem-nonce"); $form_fields = array("file-data"); if(connect_fs($url, "", WP_PLUGIN_DIR . "/filesystem/filesystem-demo", $form_fields)) { $dir = $wp_filesystem->find_folder(WP_PLUGIN_DIR . "/filesystem/filesystem-demo"); $file = trailingslashit($dir) . "demo.txt"; $wp_filesystem->put_contents($file, $text, FS_CHMOD_FILE); return $text; } else { return new WP_Error("filesystem_error", "Cannot initialize filesystem"); } } 

Вот как работает код:

• Сначала мы $wp_filesystem к глобальному объекту $wp_filesystem внутри функции. Этот объект является экземпляром класса WP_Filesystem . Он отвечает за разоблачение различных методов чтения, создания, записи и удаления файлов.
• Затем мы создаем одноразовый URL-адрес нашей страницы формы и массив с именами полей нашей формы.
• Наконец, мы подключаемся к файловой системе с помощью функции connect_fs .
• connect_fs использует функцию request_filesystem_credentials, предоставляемую WordPress, чтобы найти подходящий метод для подключения к файловой системе (прямой, FTP или SSH). В случае FTP или SSH будет отображаться форма для запроса учетных данных от пользователя. В случае прямого метода он просто возвращает true.
• Когда форма textarea отправлена ​​и request_filesystem_credentials выбирает метод FTP или SSH, тогда мы отображаем форму учетных данных и скрываем поле file-data в форме учетных данных.
• Первый параметр функции request_filesystem_credentials принимает URL-адрес, куда следует перенаправить, когда он получил правильные учетные данные. Редирект имеет тип запроса POST. Последний параметр request_filesystem_credentials — это массив имен полей, которые нужно опубликовать на URL перенаправления.
• После отправки формы учетных данных она перенаправляет обратно на исходный URL-адрес отправки формы с правильными именами полей и значениями, введенными пользователем.
• Опять же, весь процесс начинается, и мы выполняем write_file_demo . На этот раз request_filesystem_credentials имеет учетные данные, поэтому он просто вернет true.
• Затем мы используем $wp_filesystem->find_folder для ссылки на папку. Затем мы строим полный путь к файлу demo.txt .
• Мы использовали $wp_filesystem->put_contents для записи данных в файл.

Примечание. Если вы попытаетесь использовать $wp_filesystem объекта $wp_filesystem без запроса и проверки учетных данных, они не будут работать.

Чтение файла

Вот реализация функции read_file_demo .

 function read_file_demo() { global $wp_filesystem; $url = wp_nonce_url("options-general.php?page=demo", "filesystem-nonce"); if(connect_fs($url, "", WP_PLUGIN_DIR . "/filesystem/filesystem-demo")) { $dir = $wp_filesystem->find_folder(WP_PLUGIN_DIR . "/filesystem/filesystem-demo"); $file = trailingslashit($dir) . "demo.txt"; if($wp_filesystem->exists($file)) { $text = $wp_filesystem->get_contents($file); if(!$text) { return ""; } else { return $text; } } else { return new WP_Error("filesystem_error", "File doesn't exist"); } } else { return new WP_Error("filesystem_error", "Cannot initialize filesystem"); } } 

Вот как работает код:

• При чтении файла demo.txt мы сначала подключаемся к файловой системе с помощью функции request_filesystem_credentials .
• На этот раз мы не передаем поля формы в последнем параметре, потому что форма не отправлена. Мы просто передаем URL перенаправления, чтобы он был перенаправлен после получения учетных данных.
• Затем мы проверяем, существует ли файл, используя $wp_filesystem->exists . Это файл не существует, мы отображаем ошибку. В противном случае мы читаем файл с помощью функции $wp_filesystem->get_contents и возвращаем содержимое.

Предполагая, что WordPress выбрал FTP в качестве подходящего метода для создания файлов, вот скриншоты всего процесса:

Сначала, когда мы откроем демонстрационную страницу, мы увидим эту форму:

Здесь нам нужно ввести учетные данные FTP или FTPS и отправить их. Как только мы отправим это, мы увидим эту форму:

Была показана пустая текстовая область. Введите текст «Hello World !!!» и отправьте форму. Вы снова увидите форму учетных данных.

Вы должны заполнить его снова, потому что WordPress по умолчанию не хранит пароль FTP (вы можете сделать это в wp-config.php, подробнее об этом позже). Поэтому каждый раз, когда ваш плагин должен работать с файловой системой, он должен запрашивать учетные данные. Теперь его отправка будет перенаправлена ​​обратно на URL перенаправления с именами полей и значениями, представленными ранее. Вот как выглядит текстовая область:

Здесь мы читаем содержимое файла и отображаем его.

Другие методы объекта $wp_filesystem

Объект $wp_filesystem предоставляет множество других методов для выполнения различных других операций с файлами и каталогами. Мы только что видели запись и чтение n файла. Вы можете найти полный список того, что вы можете сделать, на странице документации WP_Filesystem_Base () .

Давайте проверим некоторые из важных:

• $ wp_filesystem-> delete : delete используется для удаления файла или каталога. Вам нужно передать строку, представляющую путь.
• $ wp_filesystem-> mkdir : mkdir используется для создания каталога. Требуется строка, представляющая родительский каталог.
• $ wp_filesystem-> move : move используется для перемещения файла. Он принимает два параметра: первый — это путь к файлу, а второй — каталог, куда его нужно переместить.
• $ wp_filesystem-> size : size возвращает размер файла в байтах. Вам необходимо указать путь к файлу.
• $ wp_filesystem-> chmod : chmod используется для изменения прав доступа к файлу. Он принимает три аргумента, т.е. путь к файлу, восьмеричное число разрешения и логическое значение, представляющее рекурсию.

Вы можете узнать, какой метод соединения используется WordPress для доступа к файловой системе, используя $wp_filesystem->method свойство $wp_filesystem->method .

Постоянное хранение учетных данных

Мы видели, что WordPress не хранит учетные данные FTP или SSH постоянно. Не удобно запрашивать подробности снова и снова. Существует способ постоянного хранения учетных данных с помощью файла wp-config.php .

Используйте эти параметры для хранения учетных данных FTP и SSH:

• FTP_HOST : имя хоста сервера.
• FTP_USER : имя пользователя для подключения.
• FTP_PASS : пароль, используемый при подключении
• FTP_PUBKEY : путь открытого ключа, который будет использоваться при использовании соединения SSH2.
• FTP_PRIKEY : путь закрытого ключа, который будет использоваться при использовании соединения SSH2.

Вывод

В этой статье мы увидели процесс создания страницы администратора, которая обращается к нашей файловой системе с помощью API файловой системы WordPress. Если вы пытаетесь получить доступ к файловой системе в фоновом процессе (например, с помощью задания cron), тогда невозможно отобразить форму учетных данных, если это необходимо, в этом случае вам необходимо убедиться, что вы уведомили своего пользователя. поместить учетные константы в файл wp-config.php . Вы можете пойти дальше и поэкспериментировать с этим API и поделиться своим опытом с нами ниже.