Документация для разработчиков
Темная тема

RemoveOption

Описание и параметры

bool
COption::RemoveOption(
	string module_id,
	string name = "",
	string site = false
)

Удаляет значение одного (option_id) или всех параметров модуля module_id из базы. Если не установлен параметр site_id то делается попытка найти числовой параметр option_id, принадлежащий модулю module_id для текущего сайта. Если такого параметра нет, возвращается параметр, общий для всех сайтов. Статический метод.

В новом ядре D7 имеет аналог: \Bitrix\Main\Config\Option::delete.

Параметры

ПараметрОписание С версии
module_id Идентификатор модуля.
name Идентификатор параметра.
Необязательный. По умолчанию - "" (удалить все значения параметров модуля).
site Идентификатор сайта для которого будут возвращены параметры. Необязательный. По умолчанию - false (для текущего сайта или если не установлены то общие для всех сайтов)5.0.6

Примеры использования

<?
// удалим значение параметра "Количество результатов на одной странице" 
// для модуля "Веб-формы" из базы
COption::RemoveOption("form", "RESULTS_PAGEN");
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024