Note: Tagging this as "base system" because I seem to remember that "documentation" is not used in the core queue.

Problem description

drupal_bootstrap() give s a useful reference for external scripts on how to bootstrap Drupal. After #1540136: Simplify index.php by moving DRUPAL_ROOT to bootstrap.inc following this documentation will lead to a PHP error, however.

Proposed resolution

Instead of saying:

 *   define('DRUPAL_ROOT', '/path/to/drupal');
 *   require_once DRUPAL_ROOT . '/core/includes/bootstrap.inc';
 *   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

we should say

 *   require_once '/path/to/drupal/core/includes/bootstrap.inc';
 *   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

Because bootstrap.inc now defines DRUPAL_ROOT and defining the same constant twice leads to a PHP error.

CommentFileSizeAuthor
#5 documentation_drupal_bootstrap-2056845-5.patch564 bytesStephaneQ
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave commented

In your suggestion DRUPAL_ROOT is still used but will not be defined. This should be something like:

 * @code
 *   require_once 'path/to/drupal/core/includes/bootstrap.inc';
 *   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
 * @endcode
tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
CreditAttribution: tstoeckler commented

Sorry, it's late here.
Obviously,

 * @code
*   require_once DRUPAL_ROOT . '/core/includes/bootstrap.inc';
*   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
* @endcode

does not work as DRUPAL_ROOT is defined in bootstrap.inc. #fail

Updated the issue summary accordingly.

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
CreditAttribution: tstoeckler commented

Oops, that was a crosspost. Yeah...

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
CreditAttribution: tstoeckler commented
Issue summary: View changes

Updated issue summary.

chx’s picture

chx CreditAttribution: chx commented
Component: base system » documentation

It is definitely used in the core queue.

chx’s picture

chx CreditAttribution: chx commented
Issue summary: View changes

Updated issue summary.

StephaneQ’s picture

StephaneQ
Primary language French
Location Paris 🇫🇷
CreditAttribution: StephaneQ commented
Status: Active » Needs review
FileSize
documentation_drupal_bootstrap-2056845-5.patch564 bytes
chx’s picture

chx CreditAttribution: chx commented
Status: Needs review » Reviewed & tested by the community

That looks good.

chx’s picture

chx CreditAttribution: chx commented
Issue summary: View changes

Updated issue summary.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Status: Reviewed & tested by the community » Fixed

Nice catch.

Committed and pushed to 8.x. Thanks!

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

(not verified) CreditAttribution: commented
Issue summary: View changes

rewritten issue summary