getSiteInfo()

Returns information about the site and its editor, including the site URL, whether the editor is available and currently active, and the site's publishing status. This method is synchronous. It returns null if site information isn't available.

Method declaration

Copy

Parameters

This method takes no parameters.

Returns

Copy

SiteInfo object

Copy
NameTypeDescription
wixEditorAvailablebooleanWhether Wix Editor or Wix Studio is connected to this site.
wixEditorActivebooleanWhether Wix Editor or Wix Studio is currently active and accessible. Requires both availability and a valid editor URL.
editorUrlstringOptional. The URL to access the editor for this site, if available.
siteUrlstringOptional. The URL of the site.
createSiteUrlstringOptional. A relative URL to the site creation flow. Returned only when Wix Editor or Wix Studio isn't active.
publishedbooleanOptional. Whether the site is published. Only available for certain site types.

Examples

Note: To call this method in self-managed apps, you need to create a client. See the setup guide for more details.

Verify whether Wix Editor or Wix Studio is available and active

Copy

Handle site publishing status

Copy

Conditional UI based on Wix Editor or Wix Studio availability

Copy

Last updated: 26 October 2026

Did this help?