Filters: Shortcodes

filter_shortcodes
Maintained by Picture of Frédéric Massart ⭐Frédéric Massart ⭐
Allows users to inject and modify content using shortcodes provided by other plugins.
615 sites
293 downloads
25 fans
Moodle 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10

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
Branch Up

Screenshots

Screenshot #0

Contributors

Picture of Frédéric Massart ⭐
Frédéric Massart ⭐ (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Plugins bot
    Tue, May 8, 2018, 10:50 AM
    Approval issue created: CONTRIB-7292
  • Picture of Boris Malysh
    Sat, Apr 18, 2020, 1:05 PM
    Hello! And thanks for the plugin!
    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?
  • Picture of Frédéric Massart ⭐
    Mon, Apr 20, 2020, 12:57 PM
    Hi Boris,

    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".
  • Picture of Joseph Liaw
    Thu, Jul 16, 2020, 8:55 AM
    Hi Frederic:
    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!
  • Picture of Frédéric Massart ⭐
    Thu, Jul 16, 2020, 12:06 PM
    Hi Joseph. Oh, we had forgotten to update the compatible versions! We just did. We've been using the plugin on more recent Moodle versions without any issues. Please make sure to let us know if you experience any issues.
Please login to post comments