nc_folder_path(int $folder_id, string $date = null, array $variables = null, $use_external_url = true)
Появилось в версии: 5.4
возвращает путь к разделу с указанным идентификатором
Параметры | Описание |
---|---|
$folder_id | идентификатор раздела |
$date | дата в формате YYYY-mm-dd, YYYY-mm, YYYY |
$variables | массив с дополнительными переменными |
$use_external_url | учитывать свойство «внешняя ссылка» при генерации пути; укажите FALSE, чтобы не учитывать это свойство (появилось с версии 5.6.0.16030) |
Если модуль маршрутизации отключён, функция возвращает строку с путём к разделу или false
, если раздел не существует.
При использовании модуля маршрутизации функция может вернуть false
при явной невозможности определить путь к ресурсу (в случае передачи функции некорректных аргументов), или объект класса nc_routing_path
, который может быть использован как обычная строка (объект имеет метод __toString()
). Промежуточный объект создаётся с целью оптимизации (в некоторых частях системы — например, в списке объектов — могут создаваться переменные, содержащие пути, но фактически они могут не использоваться в шаблонах; вычисление пути происходит только при первом приведении значения такой переменной к строке).