WordPress Plugin

The WordPress plugin provides some handy options to make setting up a .probo.yaml file for your WordPress site easier. To use this plugin you must declare plugin: WordPressApp in a step in your .probo.yaml file.

WordPress core and plugins generally prefer absolute URLs for links and images instead of relative URLs. Because of the way WordPress sets up their internal settings, it means Probo needs to rewrite your data in order for links to work in the test environment. To do this, Probo provides an updated wp-config.php that has the Probo.CI build URL in it. This removes any customizations you have made to your configuration file. These can be re-added with the wordpressConfig configuration option where you define a list defines and values that are then plugged into your wp-config.php file.

Configuration and Definition Configuration

• wordpressConfig {object}

  This is a key-value pair object of items to be defined in your wp-config.php file that makes up your .probo.yaml file. This is specifically useful for custom items that are added to your WordPress configration that do not translate to your Probo build configuration.

  Example

  steps: - name: Identify site URL plugin: WordPressApp wordpressConfig: - FOO: bar - BAR: baz

  This translates to the following entry being added to your WordPress configuration file as part of the customizations.

  define('FOO', 'bar'); define('BAR', 'baz');

• wordpressDebug {bool}

  This is a boolean flag to indicate if your WordPress build will be in WordPress debug mode. This defaults to false.

  Example

  steps: - name: Identify homepage URL plugin: WordPressApp wordpressDebug: true

Database Configuration

• database {string}

  The filename of the database to import if specified. Note that this database must be added to the Assets section separately.

  Example

  assets: - mydb.sql.gz steps: - name: Import database plugin: WordPressApp database: mydb.sql.gz

• databaseName {string}

  The name of the database. Defaults to wordpress.

  Example

  steps: - name: Set database name plugin: WordPressApp databaseName: mydb

• databaseGzipped {boolean}

  Whether the database was sent gzipped and whether it should therefore be gunzipped before importing.

  Example

  steps: - name: Unzip database plugin: WordPressApp databaseGzipped: true

Updating the WordPress command line (wp-cli) as part of your build process.

Sometimes it is necessary to have the latest wp-cli on your build. We frequently update our build containers to the tune of weekly or bi-weekly but no later than monthly and we package the wp-cli on our lamp stack containers. So this step is completely optional but was an issue in older versions of Probo. We’re including this in the event you run into compatibility problems or need a specific version of the wp-cli.

assets:
  - wordpress.sql.gz
steps:
  - name: Update wp-cli.
    plugin: Script
    script:
      - wp cli update --allow-root --yes

  - name: Site setup
    plugin: WordPressApp
    database: 'wordpress.sql.gz'
    databaseName: 'wordpress'
    databaseGzipped: true
    subDirectory: 'code'
    flushCaches: true

Additional Options

• subDirectory {string}

  The directory of the actual web root. Defaults to docroot.

  Example

  steps: - name: Configure web root plugin: WordPressApp subDirectory: $SRC_DIR/web

• flushCaches {boolean}

  Whether or not to flush the cache. Defaults to true.

  Example

  steps: - name: Flush caches plugin: WordPressApp flushCaches: true

• updatePlugins {boolean}

  Whether or not to attempt to update any WordPress plugins to their latest versions. Defaults to false.

  Example

  steps: - name: Update plugins plugin: WordPressApp updatePlugins: true

WordPressApp Example

Using the WordPress plugin

This example takes a database and the assets from a WordPress site and integrates them into your Probo build. Keep in mind adding assets (depending on the size) will increase the disc space consumed on a per-container basis. That said, until a reliable module for proxying assets is available for WordPress, this is a suitable alternative for having assets viewable on your WordPress application.

type: lamp
php: 8.4
database: mariadb:11.4
assets:
  - example-database.sql.gz
  - uploads.tar.gz

steps:
  - name: Setup Example.com WordPress Site
    plugin: WordPressApp
    database: example-database.sql.gz
    databaseGzipped: true
    subDirectory: web
    databasePrefix: 'ex_'
    phpIniOptions:
      memory_limit: 512M
      max_execution_time: 300

  - name: Move files into place
    plugin: Script
    script:
      - cd /assets
      - tar -xvzf uploads.tar.gz
      - mv uploads /var/www/html/wp-content

Related Articles & Information

---

Demonstration Repositories Checking & Debugging YAML