To use the site module, import * as wixSiteSite from the @wix/site-site module:
import * as wixSiteSite from "@wix/site-site";The APIs in @wix/site-site can only be used in front-end code.
Gets a code representing the site's currency.
The retrieved currency code corresponds to the currency that has been entered in the General Info section of your site's Dashboard.
The currency is used your site, apps (e.g. Wix Stores, Wix Bookings), and other Wix features.
function currency(): Promise<string>;import { site } from "@wix/site-site";
// ...
const currency = await site.currency(); // "USD"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets information about the current page or lightbox.
function currentPage(): Promise<StructurePage>;import { site } from "@wix/site-site";
// ...
const currentPage = await site.currentPage();
/* Promise resolves to:
* {
* "name": "Home",
* "type": "static",
* "url": "/home",
* "isHomePage": true
* }
*/This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the site display name.
Retrieves the site display name, which is the name that has been entered in the Website Settings section of the site's Dashboard.
function getSiteDisplayName(): Promise<string>;import { site } from "@wix/site-site";
const siteName = await site.getSiteDisplayName(); // "My Site"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Returns information about the site's pages, prefixes, and lightboxes.
The returned SiteStructure object is a flattened representation of the site.
The structure does not include the headers and links from the site's Pages menu.
function getSiteStructure(): Promise<SiteStructure>;import { site } from "@wix/site-site";
// ...
const structure = await site.getSiteStructure();
/*
* {
* "pages": [
* {
* "name": "Home",
* "type": "static",
* "url": "/home",
* "isHomePage": true
* },
* {
* "name": "Page 1",
* "type": "static",
* "url:" /page-1"
* },
* {
* "name": "Page 2",
* "type": "static",
* "url": "/page-2"
* },
* {
* "name": "Parent Page",
* "type": "static",
* "url": "/parent-page"
* },
* {
* "name": "Child Page",
* "type": "static",
* "url": "/child-page"
* },
* {
* "name": "router-page",
* "type": "template",
* "prefix": "router"
* },
* {
* "name": "MyCollection (Title)",
* "type": "template",
* "prefix": "MyCollection"
* },
* {
* "name": "MyCollection (All)",
* "type": "template",
* "prefix": "MyCollection"
* },
* {
* "name": "Dashboard Page",
* "type": "static"
* },
* {
* "name": "Shop",
* "type": "template",
* "url": "/shop",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Product Page",
* "type": "template",
* "url": "/product-page",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Thank You Page",
* "type": "template",
* "url": "/thank-you-page",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Cart",
* "type": "template",
* "url": "/cart",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Members",
* "type": "template",
* "url": "/members",
* "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
* }
* ],
* "prefixes": [
* {
* "name": "router",
* "type": "router",
* "prefix": "/router"
* },
* {
* "name": "MyCollection",
* "type": "dynamicPages",
* "prefix": "/MyCollection"
* },
* {
* "name": "MyCollection",
* "type": "dynamicPages",
* "prefix": "/MyCollection"
* },
* {
* "name": "Shop",
* "type": "app",
* "prefix: "/shop",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Product Page",
* "type": "app",
* "prefix": "/product-page",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Thank You Page",
* "type": "app",
* "prefix": "/thank-you-page",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Cart",
* "type": "app",
* "url": "/cart",
* "applicationId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
* },
* {
* "name": "Members",
* "type": "app",
* "prefix": "/members",
* "applicationId": "14ad9202-3dd3-128a-57bd-e5675fd7e313"
* }
* ],
* "lightboxes": [
* {
* "name": "Welcome (Full Screen)"
* }
* ]
* }
*/This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets a code representing the site's language.
The retrieved language code corresponds to the main site language as found in the General Info section of your site's Dashboard.
Note: If you have a multilingual site, and it is being viewed in a language
that is not the main site language, the language property still returns
the main site language. To work with the languages of a multilingual site,
use the Multilingual API.
function language(): Promise<string>;import { site } from "@wix/site-site";
// ...
const language = await site.language(); // "en"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Optimizes resource fetching of pages and lightboxes in the site so they will load faster.
Use the prefetchPageResources() function to optimize resource fetching of pages and
lightboxes you think your site visitors are likely to visit next. When the site
visitor navigates to those pages or lightboxes, they will load quicker than usual
since some of their resources have already been retrieved.
You can only prefetch resources from pages or lightboxes within the current site.
A prefetch is considered successful if the specified pages and lightboxes exist in the current site. If any of the specified pages or lightboxes do not exist, the prefetch operation returns an error status and lists of the pages and lightboxes that were not found.
function prefetchPageResources(
prefetchItems: PrefetchItems,
): Promise<PrefetchResult>;The items within the site to prefetch resources for.
import { site } from "@wix/site-site";
const response = await site.prefetchPageResources({
lightboxes: ["First Box", "Second Box"],
pages: ["/first-page", "/second-page"],
});
if (response.errors) {
// handle errors
}
/* Promise resolves to:
*
* {
* "message": "success"
* }
*/This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the site's regional settings.
The retrieved regional settings corresponds to the regional settings that has been entered in the General Info section of your site's Dashboard.
The regional settings are used to determine how numbers, dates, and currencies are displayed on your site.
function regionalSettings(): Promise<string>;import { site } from "@wix/site-site";
// ...
const regionalSettings = await site.regionalSettings(); // "en-us"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the site revision ID.
The site revision ID is a unique identifier for the current revision of your site. Each time you manually save your site or publish your site following a change, a new revision is created.
You can view and manage your site revisions in your Site History. You can use site monitoring to monitor and debug new revisions of your site.
Notes:
Since publishing your site may change the revision ID, the ID when previewing your site may be different than the ID for the published site.
The site revision ID is guaranteed to be unique, but not meaningful. Therefore, you cannot predict future revision IDs before they are created.
function revision(): Promise<string>;import { site } from "@wix/site-site";
// ...
const revision = await site.revision(); // "4x2y"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Returns the sitemap for a router or dynamic page prefix.
The routerSitemap() function returns a Promise that resolves to a list of
WixSitemapEntry objects. Each
WixSitemapEntry includes
information about a page, such as its URL, title, and name.
A sitemap is used by search engines to find the links to the site's pages.
function routerSitemap(
routerPrefix: string,
): Promise<Array<WixRouterSitemapEntry>>;The prefix of the router to get the sitemap for.
import { site } from "@wix/site-site";
// ...
site.routerSitemap("routerPrefix").then((routerSitemap) => {
const sitemap = routerSitemap;
});
/*
* sitemap:
*
* [
* {
* "url": "Ash",
* "lastModified": null,
* "changeFrequency": "",
* "priority": null,
* "title": "Ash Stowe",
* "pageName": "Ash's Page"
* },
* {
* "url": "Aiden",
* "lastModified": null,
* "changeFrequency": "",
* "priority": null,
* "title": "Aiden Johnson",
* "pageName": "Aiden's page"
* },
* {
* "url": "Jess",
* "lastModified": null,
* "changeFrequency": "",
* "priority": null,
* "title": "Jess White",
* "pageName": "Jess's page"
* },
* {
* "url": "Morgan",
* "lastModified": null,
* "changeFrequency": "",
* "priority": null,
* "title": "Morgan James",
* "pageName": "Morgan's Page"
* }
* ]
*/This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the site's timezone.
The retrieved timezone is the timezone that has been entered in the General Info section of your site's Dashboard.
The timezone is used your site, apps (e.g. Wix Stores, Wix Bookings), and other Wix features.
function timezone(): Promise<string>;import { site } from "@wix/site-site";
// ...
const timezone = await site.timezone(); // "America/New_York"This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.