Удалить файл File::deleteFile

Модуль: main — подключать отдельно не нужно

Метод File::deleteFile удаляет файл по пути. Метод создает объект File и вызывает его метод delete.

Сигнатура метода в классе Bitrix\Main\IO\File:

public static function deleteFile($path)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
path* string Задает полный путь к файлу

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает true, если файл удален или его не было. Если удалить файл не удалось, метод возвращает false. Для пути к каталогу метод возвращает true и ничего не удаляет.

Исключения

Исключение Когда возникает
Bitrix\Main\IO\InvalidPathException Путь пустой, не строка, содержит нулевой байт или через .. выходит за корень

Примеры

Пример. Код создает файл, удаляет его и проверяет, что файла нет:

<?php
use Bitrix\Main\Application;
use Bitrix\Main\IO\File;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$path = Application::getDocumentRoot() . '/upload/demo-units.txt';

File::putFileContents($path, 'kg');

var_dump(File::deleteFile($path));
var_dump(File::isFileExists($path));

Код выведет bool(true) и bool(false).

Смотрите также