summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/helpers
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2013-07-18 02:19:59 +0200
committerAndrey Andreev <narf@devilix.net>2013-07-18 02:19:59 +0200
commit2023c3d05b042cf1322286d69557c2b8bf3bd8d5 (patch)
tree2dab60654b21424ea14d9df174425501571b0a5a /user_guide_src/source/helpers
parentd5ab75e7d6636ce324416c4b3856bc552c9028d1 (diff)
Add an optional parameter to URL helpers base_url() and site_url() (supersedes #2535)
Diffstat (limited to 'user_guide_src/source/helpers')
-rw-r--r--user_guide_src/source/helpers/url_helper.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst
index 8b5361f94..7a49f188d 100644
--- a/user_guide_src/source/helpers/url_helper.rst
+++ b/user_guide_src/source/helpers/url_helper.rst
@@ -18,9 +18,10 @@ The following functions are available:
site_url()
==========
-.. php:function:: site_url($uri = '')
+.. php:function:: site_url($uri = '', $protocol = NULL)
:param string $uri: URI string
+ :param string $protocol: Protocol, e.g. 'http' or 'https'
:returns: string
Returns your site URL, as specified in your config file. The index.php
@@ -51,9 +52,10 @@ please see the :doc:`Config Library <../libraries/config>` documentation.
base_url()
===========
-.. php:function:: base_url($uri = '')
+.. php:function:: base_url($uri = '', $protocol = NULL)
:param string $uri: URI string
+ :param string $protocol: Protocol, e.g. 'http' or 'https'
:returns: string
Returns your site base URL, as specified in your config file. Example::