Merge pull request #17931 from civicrm/5.28

[civicrm-core.git] / Civi / Core / Paths.php

diff --git a/Civi/Core/Paths.php b/Civi/Core/Paths.php
index f918cf94dfbf589de53236dc309c803951dfa80a..89b433679a90b42125d156ac864be853b0415b07 100644 (file)
--- a/Civi/Core/Paths.php
+++ b/Civi/Core/Paths.php
@@ -30,6 +30,10 @@ class Paths {
    * Class constructor.
    */
   public function __construct() {
+    // Below is a *default* set of functions to calculate paths/URLs.
+    // Some variables may be overridden as follow:
+    // - The global `$civicrm_paths` may be preset before Civi boots. (Ex: via `civicrm.settings.php`, `settings.php`, or `vendor/autoload.php`)
+    // - Variables may be re-registered. (Ex: via `CRM_Utils_System_WordPress`)
     $this
       ->register('civicrm.root', function () {
         return \CRM_Core_Config::singleton()->userSystem->getCiviSourceStorage();