nc_object_url()

nc_object_url($component_id, $object_id, $action = 'full', $format = 'html', $add_date = false, array $variables = null, $to_mirror = false)

Появилось в версии: 5.4

возвращает полный (с доменным именем) URL объекта

Параметры	Описание
$component_id	идентификатор компонента
$object_id	идентификатор объекта
$action	действие: full (просмотр объекта), edit (редактирование объекта), delete (удаление объекта с подтверждением), drop (удаление объекта без подтверждения), checked (включение или выключение объекта) , subscribe (подписка на объект)
$format	формат ответа: html, xml, rss
$add_date	если true и у компонента есть поле с форматом event или event_date, к пути будет добавлена дата
$variables	массив с дополнительными переменными
$to_mirror	(с версии 5.5) bool \| int - если TRUE строит ссылку относительно подходящего включенного зеркального инфоблока на текущем сайте - если число, строит ссылку относительно зеркального инфоблока с этим ID(с любого сайта)

Возвращаемое значение

Если модуль маршрутизации отключён, функция возвращает строку с путём к странице объекта или false, если объект не существует.

При использовании модуля маршрутизации функция может вернуть false при явной невозможности определить путь к ресурсу (в случае передачи функции некорректных аргументов), или объект класса nc_routing_path, который может быть использован как обычная строка (объект имеет метод __toString()). Промежуточный объект создаётся с целью оптимизации (в некоторых частях системы — например, в списке объектов — могут создаваться переменные, содержащие пути, но фактически они могут не использоваться в шаблонах; вычисление пути происходит только при первом приведении значения такой переменной к строке).

← Назад 12.17.1 Маршруты

Наверх