Deploying a Composer-Based totally WordPress Website (Together with Bedrock) to WP Engine

Fashionable WordPress®¹ construction has more and more embraced Composer to be able to set up dependencies and give a boost to workflow consistency. Whether or not you’re the usage of a tradition Composer setup or a framework like Bedrock, WP Engine helps deploying those initiatives—with a couple of changes.

This information covers the way to construction and deploy a Composer-based web site to WP Engine the usage of GitHub Movements, together with Bedrock-specific notes.

Advantages of The usage of Composer for WordPress

Composer is a dependency control software in PHP that provides a number of benefits for WordPress construction:

• Dependency Control: Simply set up WordPress core, plugins, subject matters, and PHP programs.
• Model Keep watch over: Stay observe of actual variations of all dependencies, making sure consistency throughout environments.
• Automation: Automate updates and deployments, decreasing guide mistakes.
• Cleaner Repositories: Keep away from committing seller information or plugin code, retaining your repository blank and fascinated about tradition code.

By means of leveraging Composer, you’ll be able to create a extra maintainable and scalable WordPress challenge.

Managing Plugins and Subject matters with WPackagist

WPackagist mirrors the WordPress.org plugin and theme directories as Composer programs, permitting you to regulate them as dependencies.

To make use of WPackagist:

1. Upload WPackagist as a repository for your composer.json:

{
  "repositories": [
    {
      "type": "composer",
      "url": "https://wpackagist.org"
    }
  ]
}

2. Require plugins or subject matters the usage of the wpackagist-plugin or wpackagist-theme prefixes:

{
  "require": {
    "wpackagist-plugin/advanced-custom-fields": "^6.0",
    "wpackagist-theme/twentytwentysix": "*"
  }
}

3. Run composer set up to put in the required plugins and subject matters.

This manner guarantees that your plugins and subject matters are version-controlled and can also be simply up to date or rolled again as wanted.

Challenge Construction Issues

Standard Composer-based websites transfer the WordPress core information to another listing, for instance /internet or /public and with that the wp-content listing housing the plugins and subject matters will transfer there too. Then again, it is a other construction anticipated via WP Engine as a controlled website hosting platform. Bedrock additionally organizes WordPress information another way than the standard construction anticipated via WP Engine.

Bedrock Construction:

├── composer.json
├── composer.lock
├── config/
├── internet/
│   ├── app/            # wp-content similar
│   ├── wp/             # WordPress core
│   ├── index.php
│   └── wp-config.php
└── .env

WP Engine Anticipated Construction:

├── wp-content/
├── wp-includes/
├── wp-admin/
├── index.php
├── wp-config.php
...

To deploy a Composer or Bedrock-based web site to WP Engine, you’ll want to restructure your challenge all through the deployment procedure to check WP Engine’s expectancies.

Deployment with GitHub Movements

Use WP Engine’s reputable GitHub Motion to automate deployments. This manner syncs your wp-content/ listing and runs Composer all through the construct step.

Usual Composer Setup

For websites the usage of Composer with a typical WordPress construction:

call: Deploy to WP Engine

on:
  push:
    branches:
      - primary

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - call: Checkout repository
        makes use of: movements/checkout@v4

      - call: Setup PHP
        makes use of: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
          equipment: composer:v2

      - call: Set up Composer dependencies
        run: composer set up --no-dev --optimize-autoloader --prefer-dist

      - call: Deploy to WP Engine
        makes use of: wpengine/github-action-wpe-site-deploy@v3
        with:
          WPE_SSHG_KEY_PRIVATE: ${{ secrets and techniques.WPE_SSHG_KEY_PRIVATE }}
          WPE_ENV: your-environment-name
          SRC_PATH: wp-content/
          REMOTE_PATH: wp-content/
          FLAGS: -azvr --inplace --delete --exclude='uploads'

Together with Composer Dependencies (Not obligatory)

In case your plugins or subject matters require PHP programs from seller/, you’ll want to come with it within the deployment. Since simplest wp-content/ is synced to WP Engine, replica seller into wp-content/ and upload a mu-plugin to load the autoloader:

- call: Set up Composer dependencies
        run: composer set up --no-dev --optimize-autoloader --prefer-dist

      - call: Get ready seller for deployment
        run: |
          mkdir -p wp-content/mu-plugins

          # Create autoloader mu-plugin
          cat > wp-content/mu-plugins/00-autoloader.php << 'EOF'
          

FLAGS: -azvr --inplace --delete --exclude='uploads'