Проверить код модуля ModuleManager::isValidModule

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

Метод ModuleManager::isValidModule проверяет, что в коде модуля нет недопустимых символов. Проверяйте код из внешнего источника, например из запроса, перед тем как строить по нему путь к файлам модуля.

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

public static function isValidModule(string $moduleName): bool

Параметры

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

Параметр Тип Описание
moduleName* string Задает код модуля

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

Метод возвращает true, если код состоит только из латинских букв, цифр, точки и подчеркивания. Иначе метод возвращает false. Метод не проверяет, существует ли модуль, и считает пустую строку допустимой.

Примеры

Пример. Код проверяет три кода модуля:

<?php
use Bitrix\Main\ModuleManager;

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

foreach (['demo.units', 'demo-units', '../main'] as $code)
{
    echo $code . ' — ' . (ModuleManager::isValidModule($code) ? 'valid' : 'invalid') . PHP_EOL;
}

Код выведет valid для demo.units и invalid для двух других кодов.

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