Documentation

Powered by Minitek FAQ Book

Shortcodes

Shortcodes can be inserted anywhere (article text, custom html module, php file). The shortcodes render the subscription boxes that allow users to subscribe to various objects (articles, categories, tags, authors).

A shortcode has the following format:

{mcnotifications title="CUSTOM_TEXT" layout="default" option="com_content" item="ITEM_ID" item_params="f,b,e,t,u" category="CATEGORY_ID" category_params="f,b,c,e,t,u" tag="TAG_ID" tag_params="f,b,e,t,u" author="AUTHOR_ID" author_params="f,b,e,t,u"}

Parameters


title
title="CUSTOM_TEXT"

Optional

Adds a custom title to the subscription box. Replace CUSTOM_TEXT with your own text. Do not use spaces, only underscores. You can translate this text in Extensions > Language(s) > Overrides.


layout
layout="default"

Optional

Defines the subscription box layout. Can be default or dropdown.


option
option="com_content"

Required

Defines the object component. Enter com_content for Joomla content.


item
item="ITEM_ID"

Optional

The ID of an article. If you enter the value auto instead of a specific ID, the extension will automatically find the ID of the article. Note that auto works only if the currently viewed page is an article page.


item_params
item_params="f,b,e,t,u"

Optional  Required if item is defined in the shortcode.

Defines what will be displayed in the subscription box in the item section.

  • f : Enables the Follow button
  • b : Enables the Block button
  • e : Enables the Receive emails checkbox
  • t : Displays the article title
  • u : Enables the Unsubscribe button (for non logged in users)

category
category="CATEGORY_ID"

Optional

The ID of a category. If you enter the value auto instead of a specific ID, the extension will automatically find the ID of the category. Note that auto works only if the currently viewed page is a category page.


category_params
category_params="f,b,c,e,t,u"

Optional  Required if category is defined in the shortcode.

Defines what will be displayed in the subscription box in the category section.

  • f : Enables the Follow button
  • b : Enables the Block button
  • c : Enables the Follow children checkbox
  • e : Enables the Receive emails checkbox
  • t : Displays the category title
  • u : Enables the Unsubscribe button (for non logged in users)

tag
tag="TAG_ID"

Optional

The ID of a tag. If you enter the value auto instead of a specific ID, the extension will automatically find the ID of the tag. Note that auto works only if the currently viewed page is a tag page.


tag_params
tag_params="f,b,e,t,u"

Optional  Required if tag is defined in the shortcode.

Defines what will be displayed in the subscription box in the tag section.

  • f : Enables the Follow button
  • b : Enables the Block button
  • e : Enables the Receive emails checkbox
  • t : Displays the tag title
  • u : Enables the Unsubscribe button (for non logged in users)

author
author="AUTHOR_ID"

Optional

The ID of an author.


author_params
author_params="f,b,e,t,u"

Optional  Required if author is defined in the shortcode.

Defines what will be displayed in the subscription box in the author section.

  • f : Enables the Follow button
  • b : Enables the Block button
  • e : Enables the Receive emails checkbox
  • t : Displays the author name
  • u : Enables the Unsubscribe button (for non logged in users)
Was this helpful?
Loading...
0