Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #3209468 by joaopauloc.dev, pooja saraah, joachim: DrupalKernelInterface methods & DrupalKernel::sitePath should document the format of a site path 

(cherry picked from commit 1fe7829e37)
merge-requests/2775/head
catch 2023-02-17 08:15:19 +00:00
parent f57cba65f9
commit 44336d1e5e
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
core/lib/Drupal/Core/DrupalKernel.php
View File

@ -225,7 +225,12 @@ class DrupalKernel implements DrupalKernelInterface, TerminableInterface {
protected static $isEnvironmentInitialized = FALSE; 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 * @var string
*/ */

8
core/lib/Drupal/Core/DrupalKernelInterface.php
View File

@ -74,7 +74,9 @@ interface DrupalKernelInterface extends HttpKernelInterface, ContainerAwareInter
public function getCachedContainerDefinition(); 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 * @param string $path
* The current site path. * The current site path.
@ -85,10 +87,10 @@ interface DrupalKernelInterface extends HttpKernelInterface, ContainerAwareInter
public function setSitePath($path); public function setSitePath($path);
/** /**
* Get the site path. * Gets the site path directory.
* *
* @return string * @return string
* The current site path. * The current site path directory.
*/ */
public function getSitePath(); public function getSitePath();