Skip to main content

InstallPluginStep <ResourceType>

Installs a WordPress plugin in the Playground.

@hasRunnableExample
@needsLogin
@landingPage

/wp-admin/plugins.php

@example
<code>
{
"step": "installPlugin",
"pluginZipFile": {
"resource": "wordpress.org/plugins",
"slug": "gutenberg"
},
"options": {
"activate": true
}
}
</code>

Hierarchy

  • Pick<InstallAssetOptions, ifAlreadyInstalled>
    • InstallPluginStep

Index

Properties

optionalifAlreadyInstalled

ifAlreadyInstalled?: overwrite | skip | error

What to do if the asset already exists.

optionaloptions

Optional installation options.

pluginZipFile

pluginZipFile: ResourceType

The plugin zip file to install.

step

step: installPlugin

The step identifier.