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

SetOptionString

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

bool
CPageOption::SetOptionString(
 string module_id,
 string name,
 string value = "",
 desc=false
)

Устанавливает строковое значение параметра page_option_id для модуля module_id. Возвращает "true", если операция прошла успешна, в противном случае - "false". Нестатический метод.

Параметры

Параметр Описание С версии
module_id Идентификатор модуля.
page_option_id Произвольный идентификатор параметра страницы.
value Значение параметра.
Необязательный. По умолчанию - "".
desc Необязательный. Значение по умолчанию - "false".
site Идентификатор сайта. Значение по умолчанию - "false".5.0.6

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

<?
// Пример запрещает сохранение в сессии номера последней страницы 
// при стандартной постраничной навигации.
// По умолчанию в сессии запоминается последняя открытая страница постраничной навигации. 
// Если вы хотите изменить такое поведение для данной текущей страницы, 
// то до вызова метода CDBResult::NavPrint необходимо воспользоваться следующим кодом:
CPageOption::SetOptionString("main", "nav_page_in_session", "N");

// Для того чтобы вернуть режим по умолчанию:
CPageOption::SetOptionString("main", "nav_page_in_session", "Y");
?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх