CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 23 of 23

corestack_site_platform_plugins_set

Turn the platform plugins on or off.

Scope writeRuns as a taskNo secrets returnedCoreCluster
On this page

When to use it

Turn Corefinity's platform plugins off, or back on, for one WordPress row (the site or one of its environments). Only the site's managing agency can; the client alone cannot.

Off, the platform adds none of its plugins to the row and removes the files it put there (only files that are byte for byte its own, never a file of the same name the site's owner wrote). From then:

  • "Log in to wp-admin" (the function wp_login_link) is refused with platform_plugins_off;
  • the preview address, the pre-go-live hold on email, payments and outgoing requests, the From address for email sent with PHP mail, and the guard on a preview environment stop, while the rest of the site keeps working.

Read stops from corestack_site_platform_plugins_get, tell the person, and send confirm_off: true only once they have agreed. Turning them back on needs no confirmation: the loader is written back at once.

On a production site (keyed: true in the read), also tell the person off_warning before they agree: turning them off ends the go-live hold on email, outgoing requests, payment gateways and Action Scheduler tasks, up to about a minute after the platform applies the change. Turning them off is refused once the site is past its go-live hold; turning them back on is always allowed, and brings the hold back the same way. While they are off, such a site cannot go live: corestack_site_attach_domain refuses with platform_plugins_off until they are back on, then with platform_plugins_applying until the task this tool answers has completed.

On a production site the switch changes at once and starts the platform_plugins_key operation that applies it, and the answer is that operation's task: poll it with tasks/get, or corestack_task_get if your client has no tasks support. Its work names the operation (kind: operation, id), which corestack_site_operation_get also reads. The task completes once the platform has applied the change, with the result {operation: {id, site_id, status}}. It ends with work_failed when the platform could not apply it: the setting stays as you chose, but the site cannot go live until the same change, made again, has applied.

When no operation starts the answer comes at once, {platform_plugins, changed, operation: null}: on a row that is not a production site, and when there is nothing to do. Asking for the state the row already has changes nothing and answers changed: false. The one exception is a production site whose last change of this kind failed (its task ended with work_failed, or corestack_site_attach_domain answers platform_plugins_applying long after it): asking for the same state again starts a new operation for it and answers its task. When the platform already holds that state, the new operation asks it to apply it again.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_site_platform_plugins_set with site_id 4211, enabled true. (Turn the platform plugins on or off.) Tell me what it returned.

Inputs

confirm_offboolean

true once the person agreed to what stops; needed to turn them off.

enabledbooleanRequired

True turns the platform plugins on, false turns them off.

site_idintegerRequired

The row: the site or one of its environments. At least 1.

Example call

tools/call
{
  "name": "corestack_site_platform_plugins_set",
  "arguments": {
    "site_id": 4211,
    "enabled": true
  }
}

If it is refused

ReasonWhat to do
confirmA turn-off without confirm_off: true; details.stops lists what stops. Nothing changed.
forbiddenOnly the site's managing agency (or Corefinity staff) can change the platform plugins.
wrong_platformThe row is not a WordPress site.
runtime_lacks_capabilityThe row's runtime cannot turn them off yet; Corefinity support can move it to a newer runtime first.
site_cut_overA production site past its go-live hold keeps its platform plugins (they send its email from its verified address). Nothing changed; do not try again.
cut_over_unknownThe site could not confirm whether it is past its go-live hold, so nothing was changed. Try again in a minute.
busydeployment_running, command_running, restore_running: the site is doing something else (a change, a deployment or its rollback, a command, a restore); try again when it finishes.
unavailableThe site refused the change just now, or the platform could not save it; nothing was changed. Try again in a minute.
switched_offSite commands are switched off at the moment; stop and tell the person.
managed_elsewhereAnother control panel manages this site, so use that control panel for it. This is refused before anything else about the site, as in the Control Panel and the API. Nothing was done.
invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
rate_limitedToo many calls. Wait for the number of seconds the answer names.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.
work_failedThe task ran and ended in failure. The details carry what happened.
errorSee how this server works.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT