Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wearerequired/composer-wp-config

🧃 Composer plugin to create a wp-config.php when installing WordPress.
https://github.com/wearerequired/composer-wp-config

composer composer-plugin configuration dotenv php wordpress

Last synced: about 1 month ago
JSON representation

🧃 Composer plugin to create a wp-config.php when installing WordPress.

Host: GitHub
URL: https://github.com/wearerequired/composer-wp-config
Owner: wearerequired
License: mit
Created: 2019-03-28T11:05:36.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-03-27T09:19:09.000Z (9 months ago)
Last Synced: 2024-09-15T21:28:36.421Z (3 months ago)
Topics: composer, composer-plugin, configuration, dotenv, php, wordpress
Language: PHP
Homepage:
Size: 88.9 KB
Stars: 9
Watchers: 3
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # composer-wp-config

[![Latest Stable Version](https://poser.pugx.org/wearerequired/composer-wp-config/v/stable)](https://packagist.org/packages/wearerequired/composer-wp-config)

[![Latest Unstable Version](https://poser.pugx.org/wearerequired/composer-wp-config/v/unstable)](https://packagist.org/packages/wearerequired/composer-wp-config)

A plugin for Composer to create the WordPress configuration file which automagically defines constants from a .env file. Also includes path of Composer's autoloader in wp-config.php.

## Installation

Via Composer

```

composer require johnpbloch/wordpress wearerequired/composer-wp-config

```

Copy [`.env.example`](res/.env.example) and save it as `.env`. By default the variables are searched in a `.env` file in the same directory as `wp-config.php` .

### List of required variables

* `_HTTP_HOST` (Used when `$_SERVER['SERVER_NAME']` is not set, like WP-CLI.)

* `DB_NAME`

* `DB_USER`

* `DB_PASSWORD`

* `AUTH_KEY`

* `SECURE_AUTH_KEY`

* `LOGGED_IN_KEY`

* `NONCE_KEY`

* `AUTH_SALT`

* `SECURE_AUTH_SALT`

* `LOGGED_IN_SALT`

* `NONCE_SALT`

See also the list of [default constants](#default-constants).

### Customize path to .env file

You can override the path(s) with the following extra in your `composer.json`:

```json

{

    "extra": {

        "wp-config-env-paths": [

            "../",

            "../configs"

        ]

    }

}

```

Note that the path must be relative to the `wp-config.php` file. Run `composer build-wp-config` to rebuild the `wp-config.php` file.

## Features

* Creates `wp-config.php` one level above the WordPress installation.

* The `wp-config.php` includes the path to Composer's autoloader.

* Searches for `.env` file with the help of [PHP dotenv](https://github.com/vlucas/phpdotenv).

* Defines all variables as constants unless a constant is already set.

* Defines reasonable default values for database, object cache, debug, URL, and path constants.

* Use `{{DIR}}` as placeholder in variable values to get it replaced with `__DIR__` of `wp-config.php`.

* Supports `URL_DEVELOPMENT`, `URL_STAGING`, and `URL_PRODUCTION` for [WordPress Stage Switcher](https://github.com/roots/wp-stage-switcher). Requires at least v2.1.

* Supports loading `wp-config-prepend.php` before and `wp-config-append.php` after the default config as part of `wp-config.php`.

* Loads the WordPress plugin API early so actions and filters can be used.

## Default Constants

If the following variables are not defined they will be assigned a default value:

| Variable name | Default value |

|--------------------|------------------------------------|

| `WP_ENV` | `'development'` |

| `WP_ENVIRONMENT_TYPE` | Value of `WP_ENV` |

| `QM_DISABLED` | `true` |

| `SAVEQUERIES` | `false` |

| `WP_DEBUG` | `false` |

| `WP_DISABLE_FATAL_ERROR_HANDLER` | Value of `WP_DEBUG` |

| `WP_DEBUG_LOG` | `false` |

| `WP_DEBUG_DISPLAY` | `false` |

| `SCRIPT_DEBUG` | `false` |

| `DISALLOW_FILE_MODS` | `true` |

| `DB_HOST` | `'localhost'` |

| `DB_CHARSET` | `'utf8'` |

| `DB_COLLATE` | `''` |

| `$table_prefix` | `'wp_'` |

| `WP_CACHE_KEY_SALT` | Value of `WP_ENV` |

| `WP_HOME` | Based on `$_SERVER['SERVER_NAME']`/`_HTTP_HOST` and `$_SERVER['HTTPS']` |

| `WP_SITEURL` |  Value of `WP_HOME` |

| `WP_CONTENT_FOLDER_NAME` | `'content'` |

| `WP_CONTENT_DIR` | `__DIR__ . '/' . WP_CONTENT_FOLDER_NAME` |

| `WP_CONTENT_URL` | `WP_HOME . '/' . WP_CONTENT_FOLDER_NAME` |

## Planned Features

* Allow to change required variables via `composer.json`.

* Allow to change variables not used as a constant via `composer.json`.

* Let us know what you think is missing…




[![a required open source product - let's get in touch](https://media.required.com/images/open-source-banner.png)](https://required.com/en/lets-get-in-touch/)