Skip to content

Installs and activates one of the companion Fluent plugins from the add-on catalogue, in the background.

Only slugs present in the add-on catalogue are accepted. Repository plugins are fetched from WordPress.org; FluentCommunity Chat and FluentPlayer are installed through their own hooks and require the Pro plugin.

Endpoint

  • Method: POST

  • Path: /settings/install_plugin

  • Edition: Core

  • Controller: SettingController@installPlugin

  • Route source: fluent-community/app/Http/Routes/api.php:158

  • Controller source: fluent-community/app/Http/Controllers/SettingController.php

  • Requires the WordPress install_plugins capability in addition to the community-admin permission.

  • Writes to the plugins directory and activates code on the site.

Reconstructed sample

This endpoint belongs to a module that is not active on the reference install (or needs a file upload), so the payload below was reconstructed by reading the controller rather than recorded. Field names and types follow the source; values are illustrative.

POST Install Plugin

POST
/settings/install_plugin

Installs and activates one of the companion Fluent plugins from the add-on catalogue, in the background.

Controller: SettingController@installPlugin
Route source: fluent-community/app/Http/Routes/api.php:158

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"plugin": "string"
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"is_installed": true
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation