Skip to content

Commit 6b93671

Browse files
committed
docs: update route_to() explanation
1 parent 24d7b7f commit 6b93671

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

user_guide_src/source/general/common_functions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -369,12 +369,12 @@ Miscellaneous Functions
369369
370370
:param string $method: Route name or Controller::method
371371
:param int|string ...$params: One or more parameters to be passed to the route. The last parameter allows you to set the locale.
372-
:returns: a route (URI path)
372+
:returns: a route path (URI path relative to baseURL)
373373
:rtype: string
374374

375375
.. note:: This function requires the controller/method to have a route defined in **app/Config/routes.php**.
376376

377-
.. important:: ``route_to()`` returns a *route*, not a full URI path for your site.
377+
.. important:: ``route_to()`` returns a *route* path, not a full URI path for your site.
378378
If your **baseURL** contains sub folders, the return value is not the same
379379
as the URI to link. In that case, just use :php:func:`url_to()` instead.
380380
See also :ref:`urls-url-structure`.

0 commit comments

Comments
 (0)