Bedrock

https://github.com/roots/bedrock
Admin
Bedrock is a WordPress boilerplate that modernizes development by integrating Composer for...
Tokens:12,437
Snippets:94
Trust Score:9.8
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### WordPress Integration Workflow Installation

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/composer-package.md

Command used in .github/workflows/integration.yml to install WordPress inside the development container.

```bash
wp core install --url=http://localhost:8080 --title=Bedrock --admin_user=admin --admin_password=admin --admin_email=admin@example.com --skip-email --allow-root
```

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

### Catching Dotenv ValidationException

Source: https://github.com/roots/bedrock/blob/master/_autodocs/errors.md

Example of how to wrap the application bootstrap to handle environment configuration errors gracefully.

```php
// config/application.php is included via web/wp-config.php
try {
    require dirname(__DIR__) . '/web/wp-config.php';
} catch (Dotenv\\Exception\\ValidationException $e) {
    // missing WP_HOME / WP_SITEURL / DB_* in .env
    http_response_code(500);
    exit('Environment not configured: ' . $e->getMessage());
}
```

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

### Bedrock composer.json configuration

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/composer-package.md

The full composer.json file for the Bedrock project, defining project metadata, dependencies, repository sources, and custom installation paths for WordPress components.

```json
{
  "name": "roots/bedrock",
  "type": "project",
  "license": "MIT",
  "description": "WordPress boilerplate with Composer, easier configuration, and an improved folder structure",
  "homepage": "https://roots.io/bedrock/",
  "authors": [
    { "name": "Scott Walkinshaw", "email": "scott.walkinshaw@gmail.com", "homepage": "https://github.com/swalkinshaw" },
    { "name": "Ben Word", "email": "ben@benword.com", "homepage": "https://github.com/retlehs" }
  ],
  "keywords": ["bedrock", "composer", "roots", "wordpress-composer", "wordpress", "wp-composer", "wp-config", "wp"],
  "support": {
    "issues": "https://github.com/roots/bedrock/issues",
    "forum": "https://discourse.roots.io/category/bedrock"
  },
  "repositories": [
    { "name": "wp-packages", "type": "composer", "url": "https://repo.wp-packages.org" }
  ],
  "require": {
    "php": ">=8.3",
    "composer/installers": "^2.0",
    "oscarotero/env": "^2.0",
    "roots/bedrock-autoloader": "^1.0",
    "roots/bedrock-disallow-indexing": "^2.0",
    "roots/wordpress": "7.1.3",
    "roots/wp-config": "^1.0",
    "vlucas/phpdotenv": "^5.0",
    "wp-theme/twentytwentyfive": "^1.0"
  },
  "require-dev": {
    "laravel/pint": "^1.0",
    "pestphp/pest": "^4.0"
  },
  "config": {
    "optimize-autoloader": true,
    "preferred-install": "dist",
    "allow-plugins": {
      "composer/installers": true,
      "roots/wordpress-core-installer": true,
      "pestphp/pest-plugin": true
    },
    "sort-packages": true
  },
  "minimum-stability": "dev",
  "prefer-stable": true,
  "extra": {
    "installer-paths": {
      "web/app/mu-plugins/{$name}/": ["type:wordpress-muplugin"],
      "web/app/plugins/{$name}/": ["type:wordpress-plugin"],
      "web/app/themes/{$name}/": ["type:wordpress-theme"]
    },
    "wordpress-install-dir": "web/wp"
  },
  "scripts": {
    "lint": "pint --test",
    "lint:fix": "pint",
    "test": "pest"
  }
}
```

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

### GitHub Actions CI Composer Commands

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/composer-package.md

Commands used in .github/workflows/ci.yml for validating, installing, linting, and testing the project.

```bash
composer validate --no-check-all
```

```bash
composer install --no-progress --prefer-dist --optimize-autoloader
```

```bash
composer lint
```

```bash
composer test
```

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

### Bedrock Autoloader Bootstrap Source

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/mu-plugin-autoloader.md

The source code for the must-use plugin bootstrap. It uses conditional checks to ensure the autoloader only initializes when the blog is installed and the Autoloader class is available.

```php
<?php

/**
 * Plugin Name:  Bedrock Autoloader
 * ...
 */

namespace Roots\Bedrock;

if (is_blog_installed() && class_exists(Autoloader::class)) {
    new Autoloader();
}
```

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

### Bootstrapping chain (complete request path)

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/front-controller.md

ASCII diagram showing the request flow from web/index.php through WordPress core, including the require chain and routing dispatch.

```text
web/index.php
  └─ define('WP_USE_THEMES', true)
  └─ require web/wp/wp-blog-header.php          (Composer-installed core)
       └─ locate + require web/wp-config.php     (WordPress's own search)
            └─ require vendor/autoload.php
            └─ require config/application.php     (Config::define registry → Config::apply())
            └─ require web/wp/wp-settings.php     (core bootstrap)
       └─ route request / dispatch template
```

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

### Full source of web/index.php

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/front-controller.md

The complete front controller file. Defines WP_USE_THEMES as true and requires the WordPress core bootstrap file. This is the only constant defined in the file.

```php
<?php

/**
 * WordPress View Bootstrapper
 */
define('WP_USE_THEMES', true);
require __DIR__ . '/wp/wp-blog-header.php';
```

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

### Full source of web/wp-config.php

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/wp-config-bootstrap.md

The complete source code for the WordPress configuration entry point. This file requires the Composer autoloader, the application configuration, and the WordPress settings file.

```php
<?php

/**
 * Do not edit this file. Edit the config files found in the config/ dir instead.
 * This file is required in the root directory so WordPress can find it.
 * WP is hardcoded to look in its own directory or one directory up for wp-config.php.
 */
require_once dirname(__DIR__) . '/vendor/autoload.php';
require_once dirname(__DIR__) . '/config/application.php';
require_once ABSPATH . 'wp-settings.php';
```

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

### WP-CLI configuration in wp-cli.yml

Source: https://github.com/roots/bedrock/blob/master/_autodocs/configuration.md

Configures the path to the Composer-installed WordPress core and sets the document root for the built-in wp server command.

```yaml
path: web/wp
server:
  docroot: web
```

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

### Staging environment configuration (config/environments/staging.php)

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/environment-overrides.md

Configures staging-specific overrides, such as suppressing search-engine indexing.

```php
Config::define('DISALLOW_INDEXING', true);
```

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

### Development environment configuration (config/environments/development.php)

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/environment-overrides.md

Configures debug settings and development-specific behaviors when WP_ENV is set to 'development'.

```php
Config::define('SAVEQUERIES', true);
Config::define('WP_DEBUG', true);
Config::define('WP_DEBUG_DISPLAY', true);
Config::define('WP_DEBUG_LOG', env('WP_DEBUG_LOG') ?? true);
Config::define('WP_DISABLE_FATAL_ERROR_HANDLER', true);
Config::define('SCRIPT_DEBUG', true);
Config::define('DISALLOW_INDEXING', true);

ini_set('display_errors', '1');

Config::define('DISALLOW_FILE_MODS', false);
```

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

### Configure Env\Env option bitmask

Source: https://github.com/roots/bedrock/blob/master/_autodocs/types.md

Sets the environment variable parsing options at the top of config/application.php to enable type conversion and quote stripping.

```php
// CONVERT_* + STRIP_QUOTES + LOCAL_FIRST
Env\Env::$options
    = Env\Env::CONVERT_BOOL
    | Env\Env::CONVERT_NULL
    | Env\Env::CONVERT_INT
    | Env\Env::STRIP_QUOTES
    | Env\Env::LOCAL_FIRST;
```

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

### Dotenv loading block

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/application-config.md

This block conditionally loads environment files from the root directory and validates required variables. It uses vlucas/phpdotenv ^5.0 to manage environment configuration with specific adapter and immutability settings.

```php
if (file_exists($root_dir . '/.env')) {
    $env_files = file_exists($root_dir . '/.env.local')
        ? ['.env', '.env.local']
        : ['.env'];

    $repository = Dotenv\Repository\RepositoryBuilder::createWithNoAdapters()
        ->addAdapter(Dotenv\Repository\Adapter\EnvConstAdapter::class)
        ->addAdapter(Dotenv\Repository\Adapter\PutenvAdapter::class)
        ->immutable()
        ->make();

    $dotenv = Dotenv\Dotenv::create($repository, $root_dir, $env_files, false);
    $dotenv->load();

    $dotenv->required(['WP_HOME', 'WP_SITEURL']);
    if (!env('DATABASE_URL')) {
        $dotenv->required(['DB_NAME', 'DB_USER', 'DB_PASSWORD']);
    }
}
```

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

### Configure Env::$options type-coercion

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/application-config.md

Sets the type-coercion behavior for the Env::env() function using flags from the oscarotero/env package.

```php
Env\Env::$options
    = Env\Env::CONVERT_BOOL
    | Env\Env::CONVERT_NULL
    | Env\Env::CONVERT_INT
    | Env\Env::STRIP_QUOTES
    | Env\Env::LOCAL_FIRST;
```

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

### HTTPS reverse-proxy normalization

Source: https://github.com/roots/bedrock/blob/master/_autodocs/api-reference/application-config.md

Mutates the $_SERVER superglobal so WordPress is_ssl() detects TLS when terminating behind a proxy or load balancer.

```php
if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https') {
    $_SERVER['HTTPS'] = 'on';
}
```

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

### Dotenv Required Variable Validation

Source: https://github.com/roots/bedrock/blob/master/_autodocs/errors.md

The application enforces the presence of critical environment variables using phpdotenv. If these variables are missing, a ValidationException is raised.

```php
$dotenv->required(['WP_HOME', 'WP_SITEURL']);
if (!env('DATABASE_URL')) {
    $dotenv->required(['DB_NAME', 'DB_USER', 'DB_PASSWORD']);
}
```

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

### DATABASE_URL Parsing

Source: https://github.com/roots/bedrock/blob/master/_autodocs/errors.md

The application parses the DATABASE_URL environment variable. Malformed URLs can trigger a ValueError in PHP 8.3.

```php
$dsn = (object) parse_url(env('DATABASE_URL'));
```

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

### Parse DATABASE_URL DSN object

Source: https://github.com/roots/bedrock/blob/master/_autodocs/types.md

Casts the result of parse_url() to an object in config/application.php to define database configuration constants.

```php
if (env('DATABASE_URL')) {
    $dsn = (object) parse_url(env('DATABASE_URL'));

    Config::define('DB_NAME', substr($dsn->path, 1));
    Config::define('DB_USER', $dsn->user);
    Config::define('DB_PASSWORD', isset($dsn->pass) ? $dsn->pass : null);
    Config::define('DB_HOST', isset($dsn->port) ? "{$dsn->host}:{$dsn->port}" : $dsn->host);
}
```
Tokens:
Raw