GetOptionString

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

string
COption::GetOptionString(
	string module_id,
	string name,
	mixed def = false,
	string site = false,
	bool ExactSite=false
)

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

В новом ядре D7 аналог этой функции - Bitrix\Main\Config\Option::get.

Параметры

Параметр	Описание	С версии
module_id	Идентификатор модуля.
name	Идентификатор параметра.
def	Значение по умолчанию. Если default_value не задан, то значение для default_value будет браться из массива с именем ${module_id."_default_option"} заданного в файле /bitrix/modules/module_id/default_option.php.
site	Идентификатор сайта для которого будут возвращены параметры. Необязательный. По умолчанию - false (для текущего сайта или если не установлены то общие для всех сайтов)	5.0.6
ExactSite	Необязательный. По умолчанию "false".	10.0.11

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

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

<?
// получим поле "При регистрации добавлять в группу" 
// из настроек главного модуля
$default_group = COption::GetOptionString("main", "new_user_registration_def_group", "2");
if($default_group!="")
	$arrGroups = explode(",",$default_group);
?>