Skip to content

docs: improve force_https() description #7634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2023
Merged

docs: improve force_https() description #7634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions user_guide_src/source/general/common_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,11 @@ Miscellaneous Functions

Checks to see if the page is currently being accessed via HTTPS. If it is, then
nothing happens. If it is not, then the user is redirected back to the current URI
but through HTTPS. Will set the HTTP Strict Transport Security header, which instructs
modern browsers to automatically modify any HTTP requests to HTTPS requests for the $duration.
but through HTTPS. Will set the HTTP Strict Transport Security (HTST) header, which instructs
modern browsers to automatically modify any HTTP requests to HTTPS requests for the ``$duration``.

.. note:: This function is also used when you set
``Config\App:$forceGlobalSecureRequests`` to true.

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

Expand Down