{"id":2718,"date":"2026-06-15T23:53:22","date_gmt":"2026-06-15T23:53:22","guid":{"rendered":"https:\/\/localwp.com\/?p=2718&#038;post_type=help&#038;preview_id=2718"},"modified":"2026-06-15T23:53:23","modified_gmt":"2026-06-15T23:53:23","slug":"actions","status":"publish","type":"help","link":"https:\/\/localwp.com\/help-docs\/building-your-add-on\/actions\/","title":{"rendered":"Actions"},"content":{"rendered":"\n<div class=\"wp-block-group help-doc-toc\"><div class=\"wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained\">\n<p class=\"wp-block-paragraph\">Table of Contents:<\/p>\n\n\n<nav aria-label=\"Table of Contents\" class=\"wp-block-table-of-contents\"><ol><li><a class=\"wp-block-table-of-contents__entry\" href=\"#available-actions\">Available Actions<\/a><ol><li><a class=\"wp-block-table-of-contents__entry\" href=\"#example\">Example<\/a><\/li><\/ol><\/li><\/ol><\/nav><\/div><\/div>\n\n\n\n<div style=\"height:25px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 id=\"available-actions\" class=\"wp-block-heading has-text-color has-link-color wp-elements-edd64981f9f1fb28c3ab7679f1d74887\" style=\"color:#000000\"><strong>Available Actions<\/strong><\/h2>\n\n\n\n<div style=\"height:25px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Action Name<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Parameters<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>changeSiteDomain<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\" data-type=\"help\" data-id=\"2720\">site<\/a><\/strong><\/code><br><code>oldDomain<\/code> (string)<br><code>newDomain<\/code> (string)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>wordPressInstaller:standardInstall<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>wordPressInstaller:import<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>wordPressInstaller:import:includesWP<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>siteStarted<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><strong><code><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\" data-type=\"link\" data-id=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/code><\/strong><br><code><strong>processes<\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>siteStopped<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\" data-type=\"link\" data-id=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>siteCloned<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>siteAdded<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\" data-type=\"link\" data-id=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>siteDeleted<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">Site <code>id<\/code><\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>changeEnvironment:before<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\"><code><strong><a href=\"https:\/\/localwp.com\/help-docs\/building-your-add-on\/common-parameters\/#site\">site<\/a><\/strong><\/code><br><br>Plain object containing:<br>&#8211; <code>environment<\/code><br>&#8211; <code>webServer<\/code><br>&#8211;<code>phpVersion<\/code><br>&#8211; <code>mysqlVersion<\/code><br>&#8211; <code>clone<\/code> (boolean)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>searchReplaceWPDatabase<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">&#8211; <code>site<\/code><br>&#8211; <code>oldDomain<\/code><br>&#8211; <code>newDomain<\/code><br>&#8211; <code>subSiteURLs<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n<div id=\"help-step-block_dc3913cccdb3236c6d479639994e75e8\" class=\"help-note-container help-type-info\">\n\t<div class=\"help-icon\">\n\t\t<svg viewBox=\"0 0 512 512\" fill=\"currentColor\"><path fill=\"currentColor\" d=\"M256 48a208 208 0 1 1 0 416 208 208 0 1 1 0-416zm0 464a256 256 0 1 0 0-512 256 256 0 1 0 0 512zM216 336c-13.3 0-24 10.7-24 24s10.7 24 24 24l80 0c13.3 0 24-10.7 24-24s-10.7-24-24-24l-8 0 0-88c0-13.3-10.7-24-24-24l-48 0c-13.3 0-24 10.7-24 24s10.7 24 24 24l24 0 0 64-24 0zm40-144a32 32 0 1 0 0-64 32 32 0 1 0 0 64z\"><\/path><\/svg>\t<\/div>\n    <div class=\"help-text\">\n\t\t<p>Unlike Content Hooks and Filters, Actions do not need to return a value.<\/p>\n\t<\/div>\n<\/div>\n\n\n\n<div style=\"height:25px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4 id=\"example\" class=\"wp-block-heading has-text-color has-link-color wp-elements-094db5fda8cc802573e85d59abddc101\" style=\"color:#000000\"><strong>Example<\/strong><\/h4>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism undefined-numbers lang-js\" data-lang=\"JavaScript\"><code>hooks.addAction(&#39;siteAdded&#39;, function (site) {\n    console.log(&#39;New site added!&#39;, site);\n});<\/code><\/pre><\/div>\n\n\n\n<div style=\"height:90px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n","protected":false},"excerpt":{"rendered":"<p>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:&#8211; environment&#8211; webServer&#8211;phpVersion&#8211; mysqlVersion&#8211; clone (boolean) searchReplaceWPDatabase &#8211; site&#8211; oldDomain&#8211; newDomain&#8211; subSiteURLs Example<\/p>\n","protected":false},"author":78,"parent":2696,"menu_order":6,"template":"","tags":[],"helpcategories":[69],"class_list":["post-2718","help","type-help","status-publish","hentry","helpcategories-building-your-add-on"],"acf":{"help_keywords":""},"_links":{"self":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/help-doc\/2718","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\/2718\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/help-doc\/2696"}],"wp:attachment":[{"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/media?parent=2718"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/tags?post=2718"},{"taxonomy":"helpcategories","embeddable":true,"href":"https:\/\/localwp.com\/wp-json\/wp\/v2\/helpcategories?post=2718"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}