Local Add-on API
Download LocalCommunityAPI DocsComponents
Search…
Getting started with Add-ons
Designing your Add-on
Building your Add-on
Add-on Structure
Context API
Using local-components
Hooks
Content Hooks
Filters
Actions
Common Parameters
Example Add-ons
Powered By GitBook
Common Parameters

site

Plain JavaScript object containing information about the selected site.
Example:
1
{
2
"id": "BeyQOnaNS",
3
"localVersion": "3.1.2",
4
"container": "c61d2aba97ca2306edd42f03275dae0bbda570abe8d93e9ad2ba2a9a93bea895",
5
"phpVersion": "7.2.9",
6
"webServer": "nginx",
7
"mysqlVersion": "5.7",
8
"multiSite": null,
9
"mysql": {
10
"database": "local",
11
"user": "root",
12
"password": "root"
13
},
14
"ports": {
15
"HTTP": 4049,
16
"HTTPS": 4050,
17
"MYSQL": 4051,
18
"MAILCATCHER": 4052
19
},
20
"flywheelConnect": "flywheel-site-hash",
21
"environment": "flywheel",
22
"workspace": null,
23
"name": "Example Site",
24
"path": "/Users/username/Local Sites/example-site",
25
"domain": "example-site.local",
26
"environmentVersion": "1.3.2",
27
"sslSHA1": "14f0808d7312bf4031ee198aec75cbd20b8aee2d"
28
}
Copied!

siteStatus

String containing one of the following values:

Common statuses

    adding
    cloning
    copying
    deleting
    exporting
    exporting-db
    halted
    provisioning
    running
    saving
    stopping

Error statuses

    container-missing
    provisioning-error
    wordpress-install-error

Pulling

    pulling-downloading-backup
    pulling-importing-backup
    pulling-requesting-backup

Pushing

    pushing-packing
    pushing-processing
    pushing-uploading
Previous
Actions
Next
Example Add-ons
Last modified 7mo ago
Export as PDF
Copy link
Contents
site
siteStatus