Skip to content

Commit b2ffe41

Browse files
committed
docs: improve explanation for url_is()
1 parent 7ef79c5 commit b2ffe41

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

user_guide_src/source/helpers/url_helper.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,14 +388,17 @@ The following functions are available:
388388

389389
.. php:function:: url_is($path)
390390
391-
:param string $path: The path to check the current URI path against.
391+
:param string $path: The URL path relative to baseURL to check the current URI path against.
392392
:rtype: boolean
393393

394394
Compares the current URL's path against the given path to see if they match. Example:
395395

396396
.. literalinclude:: url_helper/023.php
397397

398-
This would match ``http://example.com/admin``. You can use the ``*`` wildcard to match
398+
This would match **http://example.com/admin**. It would match **http://example.com/subdir/admin**
399+
if your baseURL is ``http://example.com/subdir/``.
400+
401+
You can use the ``*`` wildcard to match
399402
any other applicable characters in the URL:
400403

401404
.. literalinclude:: url_helper/024.php

0 commit comments

Comments
 (0)