跳至主要内容

Shortcodes and Gutenberg Blocks

Ultimate Multisite provides shortcodes for checkout, login, customer account, and site-management interfaces. Every shortcode below is also available as a corresponding Ultimate Multisite Gutenberg block. Use the block editor when you want a visual configuration experience, or use the shortcode in the Classic Editor, a shortcode-capable widget, template content, or custom page builder.

The shortcode and its matching block provide the same feature and settings. Settings selected in a Gutenberg block are rendered as shortcode attributes when the page is saved.

Building custom customer dashboards and account pages

Create a WordPress page and combine the account-focused blocks or shortcodes in the order that suits your customer journey. For example, a compact customer dashboard might contain:

[wu_my_sites columns="3"]
[wu_current_membership]
[wu_invoices limit="5"]
[wu_site_actions]

For a site-specific account page, use My Sites to let a customer choose a site, then add Site, Account Summary, Limits & Quotas, Domains, and Actions to the destination page. Choose the destination page in the My Sites block's custom management-page setting, and use the relevant page setting in Site for its breadcrumbs.

Shortcodes that show customer, membership, billing, or site data use the current logged-in customer and selected site. Place them on pages customers can access after signing in. Use page IDs for settings that select another page, such as custom_manage_page, breadcrumbs_my_sites_page, and redirect_after_delete.

Checkout

Checkout — [wu_checkout]

Adds a checkout form to the page.

ParameterDescriptionAccepted valuesDefault
slugThe checkout form slug.Textmain-form
deferOutputs a cache-safe placeholder, then loads fresh checkout markup after visitor intent.0, 1
defer_triggerDetermines when a deferred form requests its live markup.viewport, click, loadviewport

Authentication and content

Login Form — [wu_login_form]

Adds a login form to the page.

ParameterDescriptionAccepted valuesDefault
display_titleShows or hides the title.0, 11
titleLogin form title.TextLogin
redirect_typeSelects where to send the customer after login.default, customer_site, main_sitedefault
customer_redirect_pathPath to use when redirecting to the customer site.Text/wp-admin
main_redirect_pathPath to use when redirecting to the main site.Text/wp-admin
label_usernameUsername field label; leave blank to hide it.TextUsername or Email Address
placeholder_usernameUsername field placeholder.Text
label_passwordPassword field label; leave blank to hide it.TextPassword
placeholder_passwordPassword field placeholder.Text
rememberShows or hides the Remember Me checkbox.0, 11
label_rememberRemember Me label.TextRemember Me
desc_rememberRemember Me description.TextKeep me logged in for two weeks.
label_log_inLogin button label.TextLog In

Simple Text — [wu_simple_text]

Adds a simple text block. Use it to place text, HTML, or another shortcode between account components.

ParameterDescriptionAccepted valuesDefault
simple_textContent to display.Plain text, HTML, or shortcodeText, HTML or shortcode.

Sites and memberships

My Sites — [wu_my_sites]

Lists sites owned by the current customer and provides quick-access links.

ParameterDescriptionAccepted valuesDefault
site_manage_typeSelects the page used to manage a selected site.default, wp_admin, custom_pagedefault
site_showSelects which customer sites to list.all, ownedowned
custom_manage_pagePage ID to open when site_manage_type is custom_page.Page ID0
columnsNumber of columns in the list.Number4
display_imagesShows or hides site screenshots.0, 11

Site — [wu_current_site]

Displays the currently selected site's title, URL, and quick actions.

ParameterDescriptionAccepted valuesDefault
display_breadcrumbsShows or hides breadcrumbs.0, 11
breadcrumbs_my_sites_pagePage ID for the customer site list used by breadcrumbs.Page ID0
display_descriptionShows or hides the site description.0, 10
display_imageShows or hides the site screenshot.0, 11
screenshot_sizeScreenshot size.Number200
screenshot_positionScreenshot position.right, leftright
show_admin_linkShows or hides the WordPress admin link.0, 11

Membership — [wu_current_membership]

Displays the current membership, including its plan, status, and billing cycle.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextYour Membership
display_imagesShows or hides product images.0, 11
columnsNumber of columns.Number2

Account Summary — [wu_account_summary]

Displays a summary of the customer account, including membership and site information.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextAbout this Site

Limits & Quotas — [wu_limits]

Displays the current site's usage limits, such as disk space, posts, and users.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextSite Limits
columnsNumber of columns.Number1

Billing and domains

Billing Information — [wu_billing_info]

Displays the customer's billing address and contact information.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextBilling Address

Invoices — [wu_invoices]

Displays customer invoices and payment history.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextInvoices
limitMaximum number of invoices to display; 0 shows no limit.Integer0

Payment Methods — [wu_payment_methods]

Displays and manages the customer's saved payment methods.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextPayment Method

Domains — [wu_domain_mapping]

Allows customers to manage custom domains mapped to their site.

ParameterDescriptionAccepted valuesDefault
titleSection title; leave blank to hide it.TextDomains

Adds a domain search form for purchasing or registering a domain.

ParameterDescriptionAccepted valuesDefault
product_idID of the domain product to use at checkout.Text
titleHeading above the search form.TextRegister a Domain
subtitleDescription below the heading.TextSearch for your perfect domain name.
button_labelLabel for the register button in each result.TextRegister

Customer actions and utilities

Actions — [wu_site_actions]

Displays site-management actions, including preview, publish, and delete controls.

ParameterDescriptionAccepted valuesDefault
show_change_passwordShows or hides the password link.0, 11
show_change_emailShows or hides the email-change link.0, 11
show_change_default_siteShows or hides the default-site control.0, 11
show_change_payment_methodShows or hides the payment-method control.0, 11
redirect_after_deletePage ID to open after deleting the current site.Page ID0

Generates a magic-link URL for quick authenticated site access.

ParameterDescriptionAccepted valuesDefault
site_idID of the site for which to generate a magic link.Text
display_asSelects how to display the link.anchor, button, urlanchor
link_textText for the link or button.TextVisit Site
open_in_new_tabOpens the link in a new tab.0, 10

Email Management — [wu_email_management]

Adds an email-account management panel.

ParameterDescriptionAccepted valuesDefault
titleHeading above the panel.TextEmail Accounts

Support Chat Button — [wu_support_chat_button]

Adds a button that opens the customer-support chat widget.

ParameterDescriptionAccepted valuesDefault
labelButton text.TextStart support chat
fallback_urlDestination when JavaScript is unavailable or chat cannot open.Text#um-support-chat
styleVisual button style.primary, secondaryprimary
sizeButton size.regular, small, largeregular
render_widgetEnables standalone chat-launcher behaviour; disable only if another chat widget is already on the page.0, 11
poll_intervalChat update interval in milliseconds; minimum 10000.Number15000
ticket_idOptional support ticket ID for the chat session.Number0
ws_urlOptional ws:// or wss:// real-time chat endpoint.Text