addSitePlugin( )


Important:

This API is in Developer Preview and is subject to change.

Adds a site plugin to one of the slots supported in an app created by Wix. You can specify a single slot in which you want to add the plugin, or add the plugin to one of the available slots based on a list of prioritized slots that you configure in the plugin's installation settings in your app's dashboard.

This function can only be used in page code files for dashboard pages created in the Wix editor or with Wix Blocks.

The addSitePlugin() function returns a Promise that resolves when the plugin is added to the site.

Note: To use this function, Your app must have a site plugin extension. Learn more about site plugins.

Method Declaration
Copy
Method Parameters
pluginIdstringRequired

ID of your site plugin, which you can find in your app's dashboard, in the site plugin extension's settings.


optionsAddSitePluginOptionsRequired

Options to use when adding a site plugin.

Did this help?