Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doiftrue/wordpress-composer-repo
Composer repository for WordPress core
https://github.com/doiftrue/wordpress-composer-repo
Last synced: 3 days ago
JSON representation
Composer repository for WordPress core
- Host: GitHub
- URL: https://github.com/doiftrue/wordpress-composer-repo
- Owner: doiftrue
- Created: 2023-09-24T21:04:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-10T21:53:03.000Z (2 months ago)
- Last Synced: 2024-09-11T02:14:25.627Z (2 months ago)
- Language: PHP
- Size: 92.8 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Composer Repository for WordPress core installation
==================================================
This repository simply generates a `packages.json` file that can be utilized as an additional Composer repository.
> [!NOTE]
> **OFFICIAL WordPress.org files:** Each repository contains URLs to the WordPress zip archives hosted on WordPress.org. Examples:
> - https://downloads.wordpress.org/release/wordpress-6.3.1.zip
> - https://downloads.wordpress.org/release/wordpress-6.3.1-new-bundled.zip
> - https://downloads.wordpress.org/release/wordpress-6.3.1-no-content.zip
> [!IMPORTANT]
> This repository packages is designated with `type: wordpress-dropin` (rather than `type: wordpress-core`). This is a non-standard way, but it allows to use the default [composer/installers](https://github.com/composer/installers) package. This package, in turn, allows you to install WordPress Core in the desired folder.
There are three types of Repos
-------------------------------
- `full` - with akismet and hello.php plugins.
- `new-bundled` - without akismet and hello.php plugins.
- `no-content` - without wp-content folder.
The URL of each composer repository are:
- `https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo`
- `https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo/new-bundled`
- `https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo/no-content`
You should add a new composer repository to your `composer.json` file to tell the composer which URL can be used to download a specific version of WP core.
Usage
-----
### Option 1: Install WP into the Root dir (where other project files is)
> [!WARNING]
> Do not use `composer/installers` for this type of installation. Instead, utilize a custom command for `post-autoload-dump` event to copy the required core files. This is because, during a future update, the composer will overwrite all files in your project.
```json
{
"repositories": [
{
"type": "composer",
"url": "https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo/new-bundled"
}
],
"require": {
"wordpress/wordpress": "~6.3.0"
},
"scripts": {
"post-autoload-dump": "rsync -a --exclude={wp-content/,wp-config-sample.php} ./vendor/wordpress/wordpress/* ./"
}
}
```
Command under `post-autoload-dump` copies the `vendor/wordpress/wordpress` files to the current root directory. It requires: `linux` system with `rsync` package installed.
NOTE: The `post-autoload-dump` command runs automatically after `composer install` or `composer update`.
#### Alternative Option
If the `composer/installers` package is used, then the composer will install WP-Core into the `wp-content` folder, which is not what we want. To work around this issue use the following `composer.json`:
```json
{
"repositories": [
{
"type": "composer",
"url": "https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo/no-content"
}
],
"require": {
"wordpress/wordpress": "^6",
"composer/installers": "*"
},
"extra": {
"installer-paths": {
"vendor/wordpress-core": [ "wordpress/wordpress" ]
}
},
"scripts": {
"post-autoload-dump": "sh ./dev/sh/composer-post-install.sh"
},
"config": {
"allow-plugins": {
"composer/installers": true
}
}
}
```
Now, on any composer changes the `post-autoload-dump` action will be triggered and the `dev/sh/composer-post-install.sh` file will be executed. So let's create this file with the following code:
```sh
#!/usr/bin/env sh
wp_core_dir=./vendor/wordpress-core
public_dir=./public_html
echo 'Copy WP core files'
echo '------------------'
file_list=$(
find $wp_core_dir -maxdepth 1 \
\( -name 'wp-*' -o -name 'xmlrpc.php' -o -name 'index.php' \) \
-not -name 'wp-config-sample.php' \
-not -name 'wp-content'
)
for source_file in $file_list; do
dest_file="$public_dir/$(basename "$source_file")"
echo "$source_file >>> $dest_file"
cp -ur "$source_file" "$dest_file"
done
echo '------'
echo 'Copied'
```
Now, after either `compose install` or `composer update` the `dev/sh/composer-post-install.sh` script will be executed and all WP core files will be copied from the `vendor/wordpress-core` to the site `public_html` folder (other files in this folder will not be touched).
NOTE: You may have another name for the `public_html` folder rename it in the code above.
### Option 2: Install WP core files only into a separate `wp` folder
Here we append `/no-content` to the repository URL. This will result in downloading WordPress core files without the `wp-content` folder.
In this scenario, you can utilize the [composer/installers](https://github.com/composer/installers) package to place WordPress core files in the desired folder (the `wp/` folder in this example).
```json
{
"repositories": [
{
"type": "composer",
"url": "https://raw.githubusercontent.com/doiftrue/wordpress-composer-repo/main/repo/no-content"
}
],
"require": {
"wordpress/wordpress": "~6.3.0",
"composer/installers": "*"
},
"extra": {
"installer-paths": {
"wp/": [ "wordpress/wordpress" ]
}
},
"config": {
"allow-plugins": {
"composer/installers": true
}
}
}
```
Versioning Info
---------------
WP Versions Schema: `6.3.1` = `MAJOR.MINOR.PATCH`.
Examples:
- `"dev-master"` - the latest development version.
- `"~6.3.0"` - allows update PATCHs (last number) only. Same as `"6.3.*"`.
- `"^6.3.0"` - allows update MINORs and PATCHs (all numbers except first). Same as `"^6"`.
Docs
----
https://getcomposer.org/doc/05-repositories.md#hosting-your-own