Help Docs – Local

Filters

Michael Bertram — Mon, 15 Jun 2026 23:57:59 +0000

Table of Contents: Filters enable easily modifying data that is passed around in Local. Much like WordPress’ filters, all filters in Local must return a value. Available Filters Filter Name appMenu Description Allows you to add or modify items in the main app menu (top bar menu) Callback Function Parameters _____________________________________________________________ Filter Name siteInfoMoreMenu Description...

Actions

Michael Bertram — Mon, 15 Jun 2026 23:53:22 +0000

Table of Contents: Available Actions Action Name Parameters changeSiteDomain siteoldDomain (string)newDomain (string) wordPressInstaller:standardInstall site wordPressInstaller:import site wordPressInstaller:import:includesWP site siteStarted siteprocesses siteStopped site siteCloned site siteAdded site siteDeleted Site id changeEnvironment:before site Plain object containing:– environment– webServer–phpVersion– mysqlVersion– clone (boolean) searchReplaceWPDatabase – site– oldDomain– newDomain– subSiteURLs Example

Common Parameters

Michael Bertram — Mon, 15 Jun 2026 23:50:02 +0000

Table of Contents: Plain JavaScript object containing information about the selected site. Example: String containing one of the following values…

Source

Add-on API

Michael Bertram — Mon, 15 Jun 2026 23:48:17 +0000

Local Add-on API Reference Explore the full, interactive API reference for below. Use this documentation to look up type definitions, classes, and available modules for building custom Local add-ons.

Source

Content Hooks

Michael Bertram — Mon, 15 Jun 2026 23:36:33 +0000

Table of Contents: Content Hooks allow you to inject React components into various location in Local’s UI. With Content Hooks you can do anything from adding additional buttons, table rows, or even new pages and routes. Available Content Hooks Hook Name Parameters stylesheets SiteInfoDatabase site SiteInfoDatabase_TableList site SiteInfoDatabase_TableList_TableListRow[Connect]:Before site SiteInfoOverview site SiteInfoOverview:Before site SiteInfoOverview_TableList site...

Context API

Michael Bertram — Mon, 15 Jun 2026 23:29:37 +0000

Includes the following properties: Use to run actions at certain times. Hooks are especially useful when adding in element with . Exposes Electron API. The available methods and classes will differ based on whether or not this is ran from the main process or renderer process. With the Electron API you can create dialogs, open new windows, and more.

Source

Add-on structure

Michael Bertram — Mon, 15 Jun 2026 23:29:07 +0000

Add-ons extend Local in one of two ways: The renderer process is what runs inside Local’s main window. This is where you’ll add buttons, forms, and any other user interface elements. Most Add-ons will exclusively use the renderer process entry point for the sake of simplicity. To use this entry point, ensure that a property is defined within the file, which points to the…

Source

Using local-components

Michael Bertram — Mon, 15 Jun 2026 23:27:35 +0000

If you need to add UI components to your Local Add-on, we recommend using the package which is available on npm. To see what components are available in , check out our styleguide. utilizes CSS Modules, which allows multiple versions of to be loaded into Local via multiple Add-ons. This allows for your Add-on to look and behave the same even if the…

Source

UI components

Michael Bertram — Mon, 15 Jun 2026 23:24:27 +0000

To get you up and running quickly, we’ve provided a robust set of components for use in your Add-ons! Explore the official React component library for below. Use this interactive Storybook workspace to test native UI elements—including buttons, form inputs, layouts, and modals, ensuring your custom add-on seamlessly matches the look and feel of Local.

Source

Interaction & layout

Michael Bertram — Mon, 15 Jun 2026 23:23:48 +0000

Table of Contents: Once you know what your Add-on is going to do and where it makes the most sense within the app, you can start to think about how the user will interact with it. Local is built on the premise of making complicated tasks simple. To achieve this, we work hard to design and build consistent and clear UI focused on achieving goals. To help you create these…

Source