Skip to content

Commit 7d598e7

Browse files
authored
Merge pull request #7634 from kenjis/docs-force_https
docs: improve force_https() description
2 parents 481b4c3 + 2d5fcb2 commit 7d598e7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

user_guide_src/source/general/common_functions.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,11 @@ Miscellaneous Functions
266266

267267
Checks to see if the page is currently being accessed via HTTPS. If it is, then
268268
nothing happens. If it is not, then the user is redirected back to the current URI
269-
but through HTTPS. Will set the HTTP Strict Transport Security header, which instructs
270-
modern browsers to automatically modify any HTTP requests to HTTPS requests for the $duration.
269+
but through HTTPS. Will set the HTTP Strict Transport Security (HTST) header, which instructs
270+
modern browsers to automatically modify any HTTP requests to HTTPS requests for the ``$duration``.
271+
272+
.. note:: This function is also used when you set
273+
``Config\App:$forceGlobalSecureRequests`` to true.
271274

272275
.. php:function:: function_usable($function_name)
273276

0 commit comments

Comments
 (0)