{"id":2696,"date":"2026-06-09T21:54:47","date_gmt":"2026-06-09T21:54:47","guid":{"rendered":"https:\/\/localwp.com\/?p=2696&post_type=help&preview_id=2696"},"modified":"2026-06-29T16:02:02","modified_gmt":"2026-06-29T16:02:02","slug":"building-your-add-on","status":"publish","type":"help","link":"https:\/\/localwp.com\/help-docs\/building-your-add-on\/","title":{"rendered":"Building your Add-on"},"content":{"rendered":"\n

Local is powered by Electron\/Node.js. This means all Add-ons interface with Local using a simple JavaScript API.<\/p>\n\n\n\n

With that in mind, don’t think Local Add-ons can only<\/em> be JavaScript. Node.js provides robust APIs such as child_process<\/code><\/strong><\/a> which enable executing outside binaries and shell scripts.<\/p>\n\n\n\n

Also, thanks to the vast ecosystem of modern JavaScript, you can write your Local Add-on in any language that transpiles to ES5, such as ES6, ES7, or TypeScript<\/strong><\/a>.<\/p>\n\n\n\n

You can get up and running with your new add-on quickly and easily with the Local Add-on Generator<\/strong><\/a>. It is super simple to set up, and can help you start creating your new add-on in no time! It automatically sets up a bare-bones add-on in Local, and shows some helpful tips and examples (many of which are detailed in the following sections) to jumpstart your add-on development.<\/p>\n\n\n

\n\t
\n\t\t<\/path><\/svg>\t<\/div>\n
\n\t\t

The Local Add-on API is always growing! If you need a hook to be added for any reason, please let us know in the Local Community<\/a><\/strong> and we’ll be happy to work with you.<\/p>\n\t<\/div>\n<\/div>\n\n\n\n

Contents<\/h2>\n\n\n\n

Add-on structure<\/a><\/p>\n\n\n\n

Context API<\/a><\/p>\n\n\n\n

Using local-components<\/a><\/p>\n\n\n\n

Content Hooks<\/a><\/p>\n\n\n\n

Filters<\/a><\/p>\n\n\n\n

Actions<\/a><\/p>\n\n\n\n

Add-on API<\/a><\/p>\n\n\n\n

Common Parameters<\/a><\/p>\n\n\n\n

<\/p>\n","protected":false},"excerpt":{"rendered":"

Local is powered by Electron\/Node.js. This means all Add-ons interface with Local using a simple JavaScript API. With that in mind, don’t think Local Add-ons can only be JavaScript. Node.js provides robust APIs such as child_process which enable executing outside binaries and shell scripts. Also, thanks to the vast ecosystem of modern JavaScript, you can…<\/p>\n","protected":false},"author":78,"parent":0,"menu_order":23,"template":"","tags":[],"helpcategories":[],"class_list":["post-2696","help","type-help","status-publish","hentry"],"acf":{"help_keywords":""},"_links":{"self":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/help-doc\/2696","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/help-doc"}],"about":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/types\/help"}],"author":[{"embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/users\/78"}],"version-history":[{"count":0,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/help-doc\/2696\/revisions"}],"wp:attachment":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/media?parent=2696"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/tags?post=2696"},{"taxonomy":"helpcategories","embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/helpcategories?post=2696"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}