Получить значение параметра маршрута Route::getParameterValue
Модуль: main — подключать отдельно не нужно
Метод Route::getParameterValue возвращает значение параметра маршрута по имени. Метод Router::match заполняет значения, когда находит маршрут для запроса.
Сигнатура метода в классе Bitrix\Main\Routing\Route:
public function getParameterValue($name)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| name* | string |
Задает имя параметра без фигурных скобок, например code для шаблона /units/{code}/ |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает строку со значением параметра или значение по умолчанию из настроек маршрута. Если параметра нет или метод Router::match не заполнял значения, метод возвращает null.
Метод match самого маршрута не сохраняет значения.
Примеры
Пример. Код читает параметр code у маршрута текущего запроса:
<?php
use Bitrix\Main\Application;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$app = Application::getInstance();
if ($app->hasCurrentRoute())
{
echo $app->getCurrentRoute()->getParameterValue('code');
}
else
{
echo 'Страница открыта не через маршрут';
}
Для запроса /units/kg/ к маршруту /units/{code}/ код выведет kg. Для страницы без маршрута и при запуске из консоли код выведет Страница открыта не через маршрут.
В обработчике маршрута параметры приходят аргументами действия или замыкания. Подробнее — в статье Роутинг.