Macros

Macros are special constructions which can be inserted in some text input (such as blog post or wiki). This construction is converted dynamically upon output. For example it's possible to insert join page into wiki page, or insert search results by some keyword into html block, it insert photo snippet into blog post.

Constructions have the following syntax {{~module:action:class[params]~}} where:

module internal module name, such as bx_posts or system for system calls
action action name (which actually matches module service name but not all service calls are available to use for macros for security reasons)
params JSON encoded string of parameters to pass to the call, which also matches parameters for the service call, params can be omitted if there is no parameters for the service call or parameters are optional
class class name, in most cases it can be omitted

Permissions

Using macros is available for Administrators and Moderators only, but can be enabled for other levels by enabling Use Macros action in Studio > Permissions

Known issues

Sometimes content which is inserted via macros need to load additional CSS and JS files, so it could not work correctly in some places where content is loaded dynamically, for example in Timeline. So it's better to not use macros in regular posts, the better place to use macros is in page builder blocks. Also it can be used in Wiki blocks, but Wiki blocks sometimes are reloaded dynamically when editing, so it maybe issues during Wiki editing. So editor need to know this, this is the reason it's enabled for Admins and Moderators by default.

Sample macros calls

Show join form and online users count.
Add HTML block via Studio > Pages with the following content:

<h2>There are {{~system:get_count_online_profiles:TemplServiceProfiles~}} online users on the site, join the site to talk to them:</h2>
{{~system:create_account_form:TemplServiceAccount[{"no_login_text":true, "no_auth_buttons":true}]~}}

Publicly show site stats.
Make a forum post with the following content:

Hi, look at my site stats:
{{~system:get_chart_stats:TemplChartServices~}}

Please note this post will not look correct if post is loaded in some dynamic content, like 2nd or more page in Timeline.

List all albums from particular country.
Add wiki block with the following content:

Beautiful Australia
{{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country", "keyword": "AU"}, "unit.html"]~}}

As previously noted it may not look good after block adding since it requires additional CSS/JS files, but after page reload it should look fine.

List of macros for UNA 11.0.0

Albums

API

{{~bx_api:delete_page[...]~}}

Channels

Contact

{{~bx_contact:get_block_form[...]~}}

Conversations

Discussions

ElasticSearch

{{~bx_elasticsearch:search_simple[...]~}}
{{~bx_elasticsearch:search_extended[...]~}}

Events

Files

Glossary

Groups

Invitations

{{~bx_invites:get_block_invite[...]~}}
{{~bx_invites:get_block_form_invite[...]~}}
{{~bx_invites:get_block_form_request[...]~}}

Market

Notifications

{{~bx_notifications:get_block_view[...]~}}

Organizations

Paid Levels

{{~bx_acl:get_view_url[...]~}}
{{~bx_acl:get_block_view[...]~}}
{{~bx_acl:get_membership_actions[...]~}}

Payment

{{~bx_payment:get_block_join[...]~}}
{{~bx_payment:get_block_carts[...]~}}
{{~bx_payment:get_block_cart[...]~}}
{{~bx_payment:get_block_cart_history[...]~}}
{{~bx_payment:get_block_list_my[...]~}}
{{~bx_payment:get_block_history[...]~}}

Persons

Photos

Polls

Posts

Quote of the Day

{{~bx_quoteofday:get_quote[...]~}}

Shopify

Snipcart

Spaces

System

Timeline

Videos

Wiki

{{~bx_wiki:contents[...]~}}
{{~bx_wiki:missing_translations[...]~}}
{{~bx_wiki:outdated_translations[...]~}}

12 Apr 2024