Moodle Plugins directory: Shortcodes | Moodle.org
Shortcodes
Frédéric Massart ⭐This plugins allows users to use shortcodes in content throughout Moodle to inject or modify content with ease. The shortcodes are provided by other Moodle plugins.
Usage
A shortcode is constituted of a word between square brackets. There are two types of shortcodes: the ones that wrap content, and the ones that do not. Those that do wrap content MUST have a closing tag. Here is an example using [useremail] which prints the current user's email, and [toupper] which wraps content and makes it uppercase.
Your registered email address is: [useremail].
[toupper]This text will be uppercased[/toupper].
You can also nest the shortcodes, let's make the user's email address uppercase.
Your registered email address is: [toupper][useremail][/toupper].
Some shortcodes support arguments. Those are declared in the same manner as HTML attributes. Here is an example of a shortcode that would add a collapsible section with a height of 100, and which would be collapsed by default:
[section height="100" collapsed]
Attribute values do not require to be wrapped between double quotes, but it is recommended. When the attribute does not have a value, it is considered to be true. Single quotes cannot be used in lieu of double quotes.
List of shortcodes
Once the plugin is installed, the list of all available shortcodes and documentation on how to use them will be available at the URL: http://your-moodle-site/filter/shortcodes/index.php. By default this page is available to all logged in users, though this can be changed using the permission filter/shortcodes:viewlist.
Plugins supporting shortcodes
Your plugin supports shortcodes? Let us know!
For developers
Developers can easily add support shortcodes in their plugin. See the documentation for more information.
Provided by
Useful links
Screenshots
Contributors
But unfortunately the shortcodes list (http://your-moodle-site/filter/shortcodes/index.php) is only showing [firstname], [fullname] and [off] .
The shortcodes I've seen in the description above ( [useremail], [toupper], [section height="100" collapsed]... they look very promising. But they're not there.
How can I add them to the list and use?
Are there any other shortcodes ready or use?
This plugin does not come with a list of shortcodes by default, except for the 3 that you found. We created this plugin to allow other developers to add shortcodes to their own plugins. Keeping the built-in shortcodes to a minimum was very important to keep the performance impact to its minimum unless new features are needed. There are tons of shortcodes we could be adding, if you are looking for a plugin that provides a similar functionality but comes with a lot of pre-defined shortcodes, please search for "filtercodes".
Any plans on updating for 3.8 since 3.8 is Long Term Support? Thanks for sharing your great work with teachers around the world to help gamify their courses to make it more engaging and fun for students!
I can't find any documentation on how to use this plugin with your LevelUp+ plugin. I would like to know how to use the [xpdrop] feature, and how to change the amount of XP each drop gives. Could you point me to the documentation, or let me know how to do it in your reply. Much appreciated.
I use shortcodes in combination with Level Up XP+.
Initially I thought the short code xppoints would show the current number of points for a user but it only shows a specific number of points.
Is there anyway to have the current number of points showed? For example, "Hello [firstname], you currently have XXX points."
Thank you for your feedback. Shortcodes are defined by their respective plugins, so it would be the responsibility of Level Up XP to declare a short code to display the points of a user.
Having said that, you are correct. The xppoints shortcode is meant to be used to display a certain amount of points, for instance to advertise the points received for completing an activity. That shortcode cannot be used to display the user's point total.
Such shortcode does not yet exist, but it is a good suggestion and we'll definitely consider adding it in our next release.
Thank you!
Fred
I have an error on Filter Shortcodes
Exception - Call to undefined function filter_shortcodes\filter_shortcodes_make_env()
Exception - Call to undefined function filter_shortcodes\filter_shortcodes_make_env()
Could you please confirm:
1. Which version of filter_shortcodes you are using;
2. Which version of Moodle you are using;
3. When/where this error comes from (you can get more details by enabling debugging from the admin)
Thank you!