Configuration Options

Property	Required	Default
version	Required
themes	Optional	null
plugins	Optional	null
seedsPath	Optional	cypress/seeds
multisite	Optional	false
url	Optional	http://localhost
port	Optional	80
dbPort	Optional	3306
configFile	Optional	null
config	Optional	null
timezone	Optional	null
muPlugins	Optional	null
wpContent	Optional	null
locale	Optional	en_US
phpVersion	Optional	7.4
phpMemoryLimit	Optional	128M

version

• Type: any of the folllowing: string or array
• Example: [5.4, 5.5]

themes

• Type: string[]
• Example: ["./path/to/theme"]

plugins

• Type: string[]
• Example: ["./path/to/plugin", "./another/path/to/plugin"]

seedsPath

• Type: string
• Example: cypress/seeds

multisite

• Type: any of the folllowing: boolean or string
• Example: true

url

• Type: any of the folllowing: boolean or string
• Example: my-wordpress-site.test

port

• Type: number
• Example: 3000

dbPort

• Type: number
• Example: 3307

configFile

• Type: string
• Example: path/to/config.php

constraints

pattern: the string must match the following regular expression:

^.*.php$

try pattern

config

• Type: object

timezone

• Type: string

muPlugins

muPlugins

• Type: object

Property	Required
vip	Optional
path	Optional

vip

• Type: boolean

path

• Type: string

wpContent

wpContent

• Type: object

Property	Required
path	Required
activeTheme	Optional
activePlugins	Optional

path

• Type: string
• Example: path/to/wp-content

activeTheme

• Type: string

activePlugins

• Type: string[]

locale

Set the locale of WordPress. Any locale set is dependent on compatibility as outlined in the WordPress polyglot and locales page.

• Type: string

phpVersion

Set the version of PHP to run the WP-Cypress environment on.

• Type: number

phpMemoryLimit

Set the memory limit of PHP running on the created environment.

• Type: string
• Example: 1G - 1 Gigabyte