string
COption::GetOptionString(
 string module_id,
 string option_id,
 mixed default_value = false
)

The method GetOptionString returns string value of the parameter option_id, belonging to module_id.

Parameters

Parameter	Description
module_id	Module ID.
option_id	Parameter ID.
default_value	Default value. If default_value is not specified, it will be taken from the array with name ${module_id."_default_option"} specified in file /bitrix/modules/module_id/default_option.php.

See Also

• Module parameters
• Kernel module settings
• COption::GetOptionInt

Example

<?
// obtain field "Add to group upon registration" 
// from the Kernel module settings
$default_group = COption::GetOptionString("main", "new_user_registration_def_group", "2");
if($default_group!="")
    $arrGroups = explode(",",$default_group);
?>

© 2001-2005 Bitrix

Bitrix Site Manager - Content Management & Portal Solutions