Drupal Core

https://github.com/drupal/core
Admin
Drupal Core is the foundational component of the Drupal content management system, providing...
Tokens:51,756
Snippets:380
Trust Score:8.1
License:GPL-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Quickstart: Create project and run quick-start

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Quickstart installation commands. The first command creates a new Drupal project in the 'drupal' directory. The second command starts the quick-start installer with a 256M memory limit; a successful installation opens the new site in the browser.

```bash
composer create-project drupal/recommended-project drupal
```

```bash
cd drupal && php -d memory_limit=256M vendor/bin/dr quick-start standard
```

--------------------------------

### Install dependencies with yarn install

Source: https://github.com/drupal/core/blob/11.x/assets/vendor/tabbable/README.txt

Run this command in the root directory of the tabbable library to install required dependencies before building.

```bash
yarn install
```

--------------------------------

### Show quick-start help

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Displays available options for the quick-start command, which may need to be configured before running the installation.

```bash
vendor/bin/dr quick-start --help
```

--------------------------------

### Write-protect settings.php and sites/default after install

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Manually write-protects the settings.php file and the sites/default directory if the install script fails to do so.

```bash
chmod go-w sites/default/settings.php
chmod go-w sites/default
```

--------------------------------

### Copy example.sites.php to sites.php

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates the required sites/sites.php file by copying the example file. This is the first step in enabling multisite support.

```bash
$ cp sites/example.sites.php sites/sites.php
```

--------------------------------

### Install Drupal with Composer

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates a new Drupal project in the 'drupal' directory and automatically runs composer install to download the latest stable version of Drupal and all dependencies.

```bash
composer create-project drupal/recommended-project drupal
```

--------------------------------

### Install PHP dependencies with Composer

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

Run this command in the Drupal root directory to install the development dependencies required for running tests. These dependencies should not be installed on a production site.

```bash
composer install
```

--------------------------------

### Site-specific modules and themes directory example

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Shows how to organize site-specific modules and themes within a site's configuration directory, keeping them separate from other sites.

```text
sites/sub.example.com/
  settings.php
  themes/custom_theme
  modules/custom_module
```

--------------------------------

### Example multisite directory structure

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Shows the expected directory layout for multiple sites, including subdomains and subdirectories. Each site has its own settings.php.

```text
sites/default/settings.php
sites/example.com/settings.php
sites/sub.example.com/settings.php
sites/sub.example.com.site3/settings.php
```

--------------------------------

### Grant write permission to settings.php

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Allows the web server to write to settings.php during installation.

```bash
chmod a+w sites/default/settings.php
```

--------------------------------

### Restore permissions on settings.php after install

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Removes write permissions from settings.php after installation is complete.

```bash
chmod go-w sites/default/settings.php
```

--------------------------------

### Install PHPStan test dependencies with Composer

Source: https://github.com/drupal/core/blob/11.x/tests/PHPStan/README.md

Run this command in the tests/PHPStan directory to install the required packages for testing the PHPStan rules. This creates a vendor subdirectory with all necessary dependencies, independent from Drupal core.

```bash
$ composer install

```

--------------------------------

### Run ComposerIntegrationTest.php with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/assets/scaffold/TESTING.txt

Use this command to run the ComposerIntegrationTest.php test file from the Drupal core directory. Requires the full Drupal repository and PHPUnit installed.

```bash
$ ./vendor/bin/phpunit -c core core/tests/Drupal/Tests/ComposerIntegrationTest.php
```

--------------------------------

### Log into MySQL as user

Source: https://github.com/drupal/core/blob/11.x/INSTALL.mysql.txt

Starts a MySQL client session as the specified user. Prompts for the user's password.

```bash
mysql -u username -p
```

--------------------------------

### Restore permissions on default directory after install

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Removes write permissions from the default directory after installation is complete. Leave the files directory writable.

```bash
chmod go-w sites/default
```

--------------------------------

### Start chromedriver on port 4444

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

Run this command to start chromedriver on port 4444 before running functional JavaScript tests based on WebDriverTestBase.

```bash
/path/to/chromedriver --port=4444
```

--------------------------------

### Build production files with yarn build

Source: https://github.com/drupal/core/blob/11.x/assets/vendor/tabbable/README.txt

Run this command after installing dependencies to create the production UMD build. This generates an index.umd.min.js file in the dist/ directory.

```bash
yarn build
```

--------------------------------

### Run PHPUnit test suites

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

Run one or more test suites by using the --testsuite option. The example shows running the unit suite and then running both functional and functional-javascript suites together.

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --testsuite unit
```

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --testsuite functional,functional-javascript
```

--------------------------------

### Nightwatch test directory patterns

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

These are example directory patterns where Nightwatch tests, commands, assertions, and pages can be placed.

```text
tests/Nightwatch/Tests
src/tests/Nightwatch/Tests
tests/src/Nightwatch/Tests
tests/Nightwatch/Commands
tests/src/Nightwatch/Assertions
tests/src/Nightwatch/Pages
```

--------------------------------

### Scaffold command output

Source: https://github.com/drupal/core/blob/11.x/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/README.md

Example output from running composer drupal:scaffold with the fixtures. Shows which files are linked from assets and which are skipped due to overrides or being disabled. Useful for verifying scaffold behavior in ad-hoc testing.

```text
Scaffolding files for fixtures/drupal-assets-fixture:
  - Link [web-root]/.csslintrc from assets/.csslintrc
  - Link [web-root]/.editorconfig from assets/.editorconfig
  - Link [web-root]/.eslintignore from assets/.eslintignore
  - Link [web-root]/.eslintrc.json from assets/.eslintrc.json
  - Link [web-root]/.gitattributes from assets/.gitattributes
  - Link [web-root]/.ht.router.php from assets/.ht.router.php
  - Skip [web-root]/.htaccess: overridden in my/project
  - Link [web-root]/sites/default/default.services.yml from assets/default.services.yml
  - Skip [web-root]/sites/default/default.settings.php: overridden in fixtures/scaffold-override-fixture
  - Link [web-root]/sites/example.settings.local.php from assets/example.settings.local.php
  - Link [web-root]/sites/example.sites.php from assets/example.sites.php
  - Link [web-root]/index.php from assets/index.php
  - Skip [web-root]/robots.txt: overridden in my/project
  - Link [web-root]/update.php from assets/update.php
Scaffolding files for fixtures/scaffold-override-fixture:
  - Link [web-root]/sites/default/default.settings.php from assets/override-settings.php
Scaffolding files for my/project:
  - Skip [web-root]/.htaccess: disabled
  - Link [web-root]/robots.txt from assets/robots-default.txt
```

--------------------------------

### Run PHPUnit tests for the Transliteration component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Transliteration/TESTING.txt

Use this command to run only the tests for the Transliteration component. It requires the full Drupal repository and PHPUnit installed.

```bash
$ ./vendor/bin/phpunit --group Transliteration
```

--------------------------------

### Run Discovery component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Discovery/TESTING.txt

Run the PHPUnit tests for the Discovery component using the 'Discovery' test group. Requires the full Drupal repository and PHPUnit installed via Composer.

```bash
$ ./vendor/bin/phpunit -c core --group Discovery
```

--------------------------------

### Run Diff component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Diff/TESTING.txt

Run the PHPUnit tests for the Diff component using the 'Diff' test group. Requires the full Drupal repository and PHPUnit installed in vendor.

```bash
$ ./vendor/bin/phpunit -c core --group Diff
```

--------------------------------

### Run PHPUnit tests for FrontMatter component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/FrontMatter/TESTING.txt

Run only the tests for this component using the annotated test group FrontMatter. Requires the full Drupal repository and PHPUnit setup.

```bash
$ ./vendor/bin/phpunit -c core --group FrontMatter
```

--------------------------------

### Move Drupal installation to web root

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Moves the contents of the created Drupal directory into a directory within the web server's document root or public HTML directory.

```bash
mv my_site_name /path/to/your/installation
```

--------------------------------

### Run PHPStan rule tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/tests/PHPStan/README.md

Execute the PHPUnit tests for the PHPStan rules from the tests/PHPStan directory. This runs the tests using the vendor/bin/phpunit binary installed via Composer.

```bash
$ vendor/bin/phpunit tests

```

--------------------------------

### Run PHPUnit tests for Version component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Version/TESTING.txt

Use this command to run only the tests for the Version component. It requires the full Drupal repository and PHPUnit installed. The command targets the 'Version' test group.

```bash
$ ./vendor/bin/phpunit -c core --group Version
```

--------------------------------

### Cron job using wget

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Example crontab line to run Drupal cron tasks hourly using wget. Replace the URL with your site's cron key.

```crontab
0 * * * * wget -O - -q -t 1 http://example.com/cron/YOURKEY
```

--------------------------------

### Copy default.settings.php to new site directory

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates a settings.php for a new site by copying the default settings file. The new directory name is based on the site's URL, omitting 'www.' if applicable.

```bash
$ cp sites/default/default.settings.php sites/example.com/settings.php
```

--------------------------------

### Create uploads directory and set permissions

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates a new directory for file system storage and grants write permissions to the web server.

```bash
mkdir uploads
chmod a+w uploads
```

--------------------------------

### Copy default.settings.php to settings.php

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates the settings.php file from the default template when auto-creation fails.

```bash
cp sites/default/default.settings.php sites/default/settings.php
```

--------------------------------

### Run PHPUnit test class, list groups, and run group

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

These commands show how to run a single test class, list available groups, and run all tests in a specific group. Use the -c option to specify the PHPUnit configuration file.

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml path/to/your/class/file.php
```

```bash
./vendor/bin/phpunit --list-groups
```

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --group group_name
```

--------------------------------

### Create and set permissions for files directory

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Creates the public file storage directory and grants write permissions to the web server. Required when auto-creation fails.

```bash
mkdir sites/default/files
chmod a+w sites/default/files
```

--------------------------------

### Run PHPUnit with groups and filters

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

These commands show how to combine test suites with groups and filters. Use --group to include tests in a group, --exclude-group to exclude a group, and --filter to run a specific test method.

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --testsuite build --group Composer
```

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --testsuite build --exclude-group Build
```

```bash
./vendor/bin/phpunit -c /path/to/your/phpunit.xml --testsuite unit --filter ClassTest::testMethod
```

--------------------------------

### Run PhpStorage component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/PhpStorage/TESTING.txt

Run the PHPUnit tests for the PhpStorage component using the 'PhpStorage' test group. The command must be executed from the Drupal repository root.

```bash
$ ./vendor/bin/phpunit -c core --group PhpStorage
```

--------------------------------

### Grant write permission to sites/default directory

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Allows the web server to create the files directory within sites/default. Run before re-running install.php.

```bash
chmod a+w sites/default
```

--------------------------------

### Run phpunit with web server user

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

Use this command to run phpunit as the web server user (e.g., www-data) to avoid file permission issues. Replace the path to phpunit.xml and the group name as needed.

```bash
sudo -u www-data ./vendor/bin/phpunit -c /path/to/your/phpunit.xml --group group_name
```

--------------------------------

### Run PHPUnit tests for FileSystem component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/FileSystem/TESTING.txt

Use this command to run only the tests for the FileSystem component. It requires the full Drupal repository and uses the component's annotated test group.

```bash
$ ./vendor/bin/phpunit -c core --group FileSystem
```

--------------------------------

### Create MySQL database with mysqladmin

Source: https://github.com/drupal/core/blob/11.x/INSTALL.mysql.txt

Creates a new MySQL database named 'database_name' using the mysqladmin command. Requires a MySQL user with CREATE and GRANT privileges. Prompts for the user's password.

```bash
mysqladmin -u username -p create database_name
```

--------------------------------

### Run FileSecurity component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/FileSecurity/TESTING.txt

Run the PHPUnit tests for the FileSecurity component using its annotated test group. Requires the full Drupal repository and the PHPUnit configuration in the core directory.

```bash
$ ./vendor/bin/phpunit -c core --group FileSecurity
```

--------------------------------

### Create Drupal database with createdb

Source: https://github.com/drupal/core/blob/11.x/INSTALL.pgsql.txt

Creates a new PostgreSQL database with UTF-8 encoding, owned by the specified user. Only needed if you don't already have a database set up.

```shell
createdb --encoding=UTF8 --owner=username database_name
```

--------------------------------

### Run Serialization component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Serialization/TESTING.txt

Run the PHPUnit tests for the Serialization component by specifying the Serialization test group. This command should be executed from the Drupal repository root.

```bash
$ ./vendor/bin/phpunit -c core --group Serialization
```

--------------------------------

### Multisite configuration search order

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Lists the order in which Drupal searches for site configuration files. The first match found is used.

```text
sites/www.sub.example.com.site3/settings.php
sites/sub.example.com.site3/settings.php
sites/example.com.site3/settings.php
sites/www.sub.example.com/settings.php
sites/sub.example.com/settings.php
sites/example.com/settings.php
sites/default/settings.php
```

--------------------------------

### Run PHPUnit tests for the component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Assertion/TESTING.txt

Use this command to run the PHPUnit tests for the component, filtering by its test group (e.g., 'Assertion' for the Assertion component).

```bash
$ ./vendor/bin/phpunit -c core --group Assertion
```

--------------------------------

### Set write permission on files directory after creation

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Grants the web server write access to the files directory after it has been created. Run after re-running install.php.

```bash
chmod a+w sites/default/files
```

--------------------------------

### Run FileCache component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/FileCache/TESTING.txt

Use this command to run only the tests for the FileCache component. It requires the full Drupal repository and uses the --group flag to filter tests by the component's annotated test group.

```bash
$ ./vendor/bin/phpunit -c core --group FileCache
```

--------------------------------

### Create PostgreSQL user with createuser

Source: https://github.com/drupal/core/blob/11.x/INSTALL.pgsql.txt

Creates a new PostgreSQL user for Drupal. The command prompts for a password and creates the user with encrypted password storage, without CREATEROLE or CREATEDB privileges. Only needed if you don't already have a user set up.

```shell
createuser --pwprompt --encrypted --no-createrole --no-createdb username
```

--------------------------------

### Run PHPUnit tests for the Plugin component

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Plugin/TESTING.txt

Run only the tests for this component by using the annotated test group 'Plugin'.

```bash
$ ./vendor/bin/phpunit -c core --group Plugin
```

--------------------------------

### Run DependencyInjection component tests

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/DependencyInjection/TESTING.txt

Run the PHPUnit tests for the DependencyInjection component using its annotated test group.

```bash
$ ./vendor/bin/phpunit -c core --group DependencyInjection
```

--------------------------------

### Uncomment file_private_path in settings.php

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Uncomment this line in settings.php to enable private file storage. Remove the leading '#' and enter the path for private files.

```php
# $settings['file_private_path'] = '';
```

--------------------------------

### Run Datetime component tests with PHPUnit

Source: https://github.com/drupal/core/blob/11.x/lib/Drupal/Component/Datetime/TESTING.txt

Use the --group flag to execute only the tests associated with the Datetime component.

```bash
$ ./vendor/bin/phpunit -c core --group Datetime
```

--------------------------------

### Create PostgreSQL schema for Drupal

Source: https://github.com/drupal/core/blob/11.x/INSTALL.pgsql.txt

Creates a schema for Drupal to use, owned by the specified user. Must be executed as a superuser; Drupal will not create schemas itself. Replace 'username' with the Drupal database user and 'schema_name' with the desired schema name.

```sql
CREATE SCHEMA schema_name AUTHORIZATION username;
```

--------------------------------

### Run scaffold tests with SCAFFOLD_FIXTURE_DIR

Source: https://github.com/drupal/core/blob/11.x/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/README.md

Set the SCAFFOLD_FIXTURE_DIR environment variable to place fixtures in a specific location rather than a temporary directory. After running composer unit, navigate to the fixture directory and run composer drupal:scaffold to test scaffolding. Fixtures are not deleted after the test run when this variable is set.

```bash
$ SCAFFOLD_FIXTURE_DIR=$HOME/tmp/scaffold-fixtures composer unit
$ cd $HOME/tmp/scaffold-fixtures
$ cd drupal-drupal
$ composer drupal:scaffold
```

--------------------------------

### Set file_chmod_directory in settings.php

Source: https://github.com/drupal/core/blob/11.x/tests/README.md

Add this setting to your settings.php or local.settings.php to change the default file directory permissions, which can resolve permission problems after running tests.

```php
$settings['file_chmod_directory'] = 02775;
```

--------------------------------

### Uncomment file_public_path in settings.php

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Uncomment this line in settings.php to set a custom public file path. Remove the leading '#' and enter the desired path.

```php
# $settings['file_public_path'] = 'sites/default/files';
```

--------------------------------

### Revoke read permissions on CHANGELOG.txt

Source: https://github.com/drupal/core/blob/11.x/INSTALL.txt

Optional security measure to make the Drupal version harder to determine. Run from Unix/Linux command line.

```bash
chmod a-r core/CHANGELOG.txt
```

--------------------------------

### Enable Drupal PHPStan rule in phpstan.neon

Source: https://github.com/drupal/core/blob/11.x/tests/PHPStan/README.md

Add this configuration to the phpstan.neon(.dist) file to enable the Drupal custom PHPStan rule. The rule is specified by its fully qualified class name under the 'rules' entry.

```yaml
rules:
  - Drupal\PHPStan\Rules\ComponentTestDoesNotExtendCoreTest

```

--------------------------------

### Grant Drupal database privileges

Source: https://github.com/drupal/core/blob/11.x/INSTALL.mysql.txt

Grants the required privileges on the Drupal database to the specified user. Replace placeholders with actual database name, username, host, and password. If successful, MySQL replies with 'Query OK, 0 rows affected'.

```sql
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER,
  CREATE TEMPORARY TABLES ON database_name.*
  TO 'username'@'localhost' IDENTIFIED BY 'password';
```
Tokens:
Raw