Merge pull request #5808 from kenjis/fix-current_url

docs: clarify that current_url() returns URL based on Config\App

Author: kenjis

system/Helpers/url_helper.php

@@ -109,7 +109,7 @@ function base_url($relativePath = '', ?string $scheme = null): string
 
 if (! function_exists('current_url')) {
     /**
-     * Returns the current full URL based on the IncomingRequest.
+     * Returns the current full URL based on the Config\App settings and IncomingRequest.
      * String returns ignore query and fragment parts.
      *
      * @param bool                 $returnObject True to return an object instead of a string

user_guide_src/source/helpers/url_helper.rst

@@ -88,8 +88,9 @@ The following functions are available:
     :returns: The current URL
     :rtype:    string|\\CodeIgniter\\HTTP\\URI
 
-    Returns the full URL (including segments) of the page being currently
-    viewed.
+    Returns the full URL (including segments) of the page being currently viewed.
+    However for security reasons, it is created based on the ``Config\App`` settings,
+    and not intended to match the browser URL.
 
     .. note:: Calling this function is the same as doing this: