@@ -121,27 +121,32 @@ The following functions are available:
121121 use a known and trusted source. If the session hasn't been loaded, or is otherwise unavailable,
122122 then a sanitized version of HTTP_REFERER will be used.
123123
124- .. php :function :: uri_string([$relative = false] )
124+ .. php :function :: uri_string()
125125
126- :param boolean $relative: True if you would like the string relative to baseURL
127126 :returns: A URI string
128- :rtype: string
127+ :rtype: string
128+
129+ Returns the path part of the current URL relative to baseURL.
129130
130- Returns the path part of the current URL.
131- For example, if your URL was this::
131+ For example, when your baseURL is **http://some-site.com/ ** and the current URL is::
132132
133133 http://some-site.com/blog/comments/123
134134
135135 The function would return::
136136
137- /blog/comments/123
137+ blog/comments/123
138+
139+ When your baseURL is **http://some-site.com/subfolder/ ** and the current URL is::
138140
139- Or with the optional relative parameter::
141+ http://some-site.com/subfolder/blog/comments/123
142+
143+ The function would return::
140144
141- app.baseURL = http://some-site.com/subfolder/
145+ blog/comments/123
142146
143- uri_string(); // "/subfolder/blog/comments/123"
144- uri_string(true); // "blog/comments/123"
147+ .. note :: In previous versions, the parameter ``$relative = false`` was defined.
148+ However, due to a bug, this function always returned a path relative to baseURL.
149+ Since v4.3.2, the parameter has been removed.
145150
146151.. php :function :: index_page([$altConfig = null])
147152
0 commit comments