SetOptionString
Описание и параметры
bool COption::SetOptionString( string module_id, string name, string value = "", mixed desc = false, string site = "" )
Устанавливает строковое значение параметра option_id для модуля module_id. Если указан site_id, параметр установится только для этого сайта и не будет влиять на аналогичный параметр другого сайта. Возвращает true, если операция прошла успешна, в противном случае - false. Статический метод.
В новом ярде D7 имеет аналог: \Bitrix\Main\Config\Option::set
Параметры
Параметр | Описание | С версии | Не используется |
---|---|---|---|
module_id | Идентификатор модуля. Длина не более 50 символов. | ||
name | Идентификатор параметра. Длина не более 50 символов. | ||
value | Значение параметра.
Необязательный. По умолчанию - "". Максимальная сохраняемая длина значения - 2000 символов. | ||
desc | Описание параметра.
Необязательный. По умолчанию - "false" (описание отсутствует). | 14.0.0 | |
site | Идентификатор сайта, для которого устанавливается параметр. Необязательный. Если установлен false, то будет текущий сайт (с 14.0). | 5.0.6 |
Смотрите также
Примеры использования
<? // установим значение для поля // "E-Mail администратора сайта (отправитель по умолчанию)" // из настроек главного модуля COption::SetOptionString("main","email_from","admin@site.com"); ?>
© «Битрикс», 2001-2024, «1С-Битрикс», 2024