From 2d5fcb2a9d5440e3dfa5b5c7471905232e0f3e4a Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 28 Jun 2023 11:11:20 +0900 Subject: [PATCH] docs: improve force_https() description --- user_guide_src/source/general/common_functions.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index a68d500ad315..5d41dde21fab 100755 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -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)