Local Add-on API
Download LocalCommunityAPI DocsComponents
  • Getting started with Add-ons
  • Designing your Add-on
    • The Local interface
    • Where should I put my Add-on?
    • Interaction & layout
    • UI components
  • 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
On this page
  • site
  • siteStatus
Export as PDF
  1. Building your Add-on
  2. Hooks

Common Parameters

site

Plain JavaScript object containing information about the selected site.

Example:

{
    "id": "BeyQOnaNS",
    "localVersion": "3.1.2",
    "container": "c61d2aba97ca2306edd42f03275dae0bbda570abe8d93e9ad2ba2a9a93bea895",
    "phpVersion": "7.2.9",
    "webServer": "nginx",
    "mysqlVersion": "5.7",
    "multiSite": null,
    "mysql": {
      "database": "local",
      "user": "root",
      "password": "root"
    },
    "ports": {
      "HTTP": 4049,
      "HTTPS": 4050,
      "MYSQL": 4051,
      "MAILCATCHER": 4052
    },
    "flywheelConnect": "flywheel-site-hash",
    "environment": "flywheel",
    "workspace": null,
    "name": "Example Site",
    "path": "/Users/username/Local Sites/example-site",
    "domain": "example-site.local",
    "environmentVersion": "1.3.2",
    "sslSHA1": "14f0808d7312bf4031ee198aec75cbd20b8aee2d"
  }

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

PreviousActionsNextExample Add-ons

Last updated 4 years ago