Получить адрес действия Controller::getActionUri
Модуль: main — подключать отдельно не нужно
Метод Controller::getActionUri возвращает адрес, по которому клиент вызовет действие, например /bitrix/services/main/ajax.php?action=main.controller.useroption.set. Метод нужен для ссылок и форм, которые вызывают действие без BX.ajax.runAction.
Сигнатура метода в классе Bitrix\Main\Engine\Controller:
final public function getActionUri(string $actionName, array $params = [], bool $absolute = false): Uri
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| actionName* | string |
Задает имя действия без имени контроллера |
| params | array |
Задает параметры запроса. По умолчанию — пустой массив |
| absolute | bool |
Значение true добавляет схему и хост. По умолчанию — false |
Возвращаемое значение
Метод возвращает объект Uri. Адрес содержит имя действия и параметры из params. Параметр SITE_ID метод добавляет, если определена константа SITE_ID и запрос пришел не из административного раздела.
Особенности
- Метод строит имя контроллера из модуля и пространства имен класса. Для класса вне каталога модуля адрес будет неверным.
- Для контроллера компонента, файл которого лежит в каталоге
/components/, метод добавляет в адрес параметрcс именем компонента иmode=ajax. Параметрactionтогда содержит только имя действия. - Адрес не содержит CSRF-токен. Для POST-запроса передайте
sessidсами.
Примеры
Пример. Код строит адрес действия контроллера ядра:
<?php
use Bitrix\Main\Controller\UserOption;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
echo (new UserOption())->getActionUri('set', ['name' => 'x'])->getUri();
Код выведет /bitrix/services/main/ajax.php?action=main.controller.useroption.set&SITE_ID=s1&name=x. Значение SITE_ID зависит от сайта.