From 1fe7829e37c0069b295de45e898abc4366f456fd Mon Sep 17 00:00:00 2001
From: catch <catch@35733.no-reply.drupal.org>
Date: Fri, 17 Feb 2023 08:15:19 +0000
Subject: [PATCH] Issue #3209468 by joaopauloc.dev, pooja saraah, joachim:
DrupalKernelInterface methods & DrupalKernel::sitePath should document the
format of a site path
---
core/lib/Drupal/Core/DrupalKernel.php | 7 ++++++-
core/lib/Drupal/Core/DrupalKernelInterface.php | 8 +++++---
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/core/lib/Drupal/Core/DrupalKernel.php b/core/lib/Drupal/Core/DrupalKernel.php
index c2457761e062..694113fb57e6 100644
--- a/core/lib/Drupal/Core/DrupalKernel.php
+++ b/core/lib/Drupal/Core/DrupalKernel.php
@@ -224,7 +224,12 @@ class DrupalKernel implements DrupalKernelInterface, TerminableInterface {
protected static $isEnvironmentInitialized = FALSE;
/**
- * The site directory.
+ * The site path directory.
+ *
+ * Site path is relative to the app root directory.
+ * Usually defined as "sites/default".
+ *
+ * By default, drupal uses sites/default.
*
* @var string
*/
diff --git a/core/lib/Drupal/Core/DrupalKernelInterface.php b/core/lib/Drupal/Core/DrupalKernelInterface.php
index dfd00f20170e..f42e8eec6fb3 100644
--- a/core/lib/Drupal/Core/DrupalKernelInterface.php
+++ b/core/lib/Drupal/Core/DrupalKernelInterface.php
@@ -74,7 +74,9 @@ public function getContainer();
public function getCachedContainerDefinition();
/**
- * Set the current site path.
+ * Set the current site path directory.
+ *
+ * Format: "folder-name/child-folder" usually uses "sites/default".
*
* @param string $path
* The current site path.
@@ -85,10 +87,10 @@ public function getCachedContainerDefinition();
public function setSitePath($path);
/**
- * Get the site path.
+ * Gets the site path directory.
*
* @return string
- * The current site path.
+ * The current site path directory.
*/
public function getSitePath();
--
GitLab