Moodle plugins directory: FilterCodes

The FilterCodes plugin for Moodle enables you to insert plain text tags like {firstname} into your Moodle site or course content in order to to personalize the site to the individual students.

Examples uses for this plugin include:

• Personalizing course content.
• Display certain content depending on the user's role.
• Conditionally display content depending on whether the user is enrolled in the current course.
• Create links that normally require the users ID as part of the URL.
• Insert default user information into Contact Form for Moodle forms.

Development efforts for this project are sponsored by the kind folks at TNG Consulting Inc..

Moodle metadata filters

• {firstname} : Display the user's first name.
  
• {surname} or {lastname} : Display the user's surname (family/last name).
• {fullname} : Display the user's first name and surname.
• {alternatename} : Display the user's alternate name. If blank, will display user's first name instead.
• {city} : Display the user's city.
• {country} : Display the user's country.
• {email} : Display the user's email address.
• {userid} or %7Buserid%7D : Display the user's ID.
• {username} : Display the user's username.
• {scrape url="..." tag="..." class="..." id="..." code="..."} : Scrapes the content from another web page. Must be enabled in FilterCodes settings.
  
• {userpictureurl X} : Display the user's profile picture URL. X indicates the size and can be sm (small), md (medium) or lg (large). If the user does not have a profile picture or is logged out, the default faceless profile photo URL will be shown instead.
• {userpictureimg X} : Generates an <img> html tag containing the user's profile picture. X indicates the size and can be sm (small), md (medium) or lg (large). If the user does not have profile picture or is logged out, the default faceless profile photo will be used instead.
• {usercount} : Count total number of registered users on the site. Does not included deleted users, primary admin or guest.
  
• {usersactive} : Count total number of registered users on the site. Does not included deleted users, disabled users, primary admin or guest.
• {usersonline} : Total number of users who were online in the last 5 minutes.
• {siteyear} : 4-digit current year.
• {coursename} : Display the name of the current course or the site name if not in a course.
  
• {courseshortname} : Display the short name of the current course or the site short name if not in a course.
  
• {coursestartdate} : Course start date. Will display "Open event" if there is no start date.
  
• {courseenddate} : Course end date. Will display "Open event" if there is no end date.
• {coursecompletiondate} : Course completion date. If not completed, will display "Not completed". Will also detect if completion is not enabled.
• {coursecount} : Total number of courses on this Moodle site (not including Front Page).
  
• {mycourses} : Display an unordered list of links to all my enrolled courses.
  
• {mycoursesmenu} : A second level list of courses with links for use in custom menus (filtering must be supported by the theme).
• {categories} : Display an unordered list of links to all course categores.
• {categoriesmenu} : A second level list of categories with links for use in custom menus (filtering must be supported by the theme).
• {institution} : Display the name of the institution from the user's profile.
• {department} : Display the name of the department from the user's profile.
• {courseid} or %7Bcourseid%7D : Display a course's ID.
• {wwwroot} : Display the root URL of the Moodle site.
• {protocol} : http or https
• {referrer} : Referring URL
• {ipaddress} : User's IP Address.
• {sesskey} or %7Bsesskey%7D : Moodle session key.
• {recaptcha} : Display the ReCAPTCHA field - for use with Contact Form for Moodle. Note: Will be blank if user is logged-in using a non-guest account.
• {readonly} : To be used within form input fields to make them read-only if the user is logged-in.
• {getstring:component_name}stringidentifier{/getstring} or {getstring}stringidentifier{/getstring}: Display a Moodle language string in the current language. If no component name (plugin) is specified, will default to "moodle".
  

Conditionally display content filters

• {ifenrolled}{/ifenrolled} : Will display the enclosed content only if the user is enrolled in the current course.
  
• {ifnotenrolled}{/ifnotenrolled} : Will display the enclosed content only if the user is not enrolled in the current course.
• {ifloggedin}{/ifloggedin} : Will display the enclosed content only if the user is logged in as non-guest.
• {ifloggedout}{/ifloggedout} : Will display the enclosed content only if the user is logged out or is loggedin as guest.
• {ifguest}{/ifguest} : Will display the enclosed content only if the user is logged-in as guest.
• {ifstudent}{/ifstudent} : Will display the enclosed content only if the user is logged-in and enrolled in the course (no other roles).
• {ifassistant}{/ifassistant} : Will display the enclosed content only if the user is logged-in as a non-editing teacher in the current course.
• {ifminassistant}{/ifminassistant} : Will display the enclosed content only if the user is logged-in as a non-editing teacher or above in the current course.
• {ifteacher}{/ifteacher} : Will display the enclosed content only if the user is logged-in as a teacher in the current course.
• {ifminteacher}{/ifminteacher} : Will display the enclosed content only if the user is logged-in as a teacher or above in the current course.
• {ifcreator}{/ifcreator} : Will display the enclosed content only if the user is logged-in as a course creator.
• {ifmincreator}{/ifmincreator} : Will display the enclosed content only if the user is logged-in as a course creator or above.
• {ifmanager}{/ifmanager} : Will display the enclosed content only if the user is logged-in as a manager.
• {ifminmanager}{/ifminmanager} : Will display the enclosed content only if the user is logged-in as a manager or above.
• {ifadmin}{/ifadmin} : Will display the enclosed content only if the user is logged-in as an administrator.
• {ifhome}{/ifhome} : Will display the enclosed content only if the user is on the Moodle Home Front Page.
  
• {ifdashboard}{/ifdashboard} : Will display the enclosed content only if the user is on the Moodle Dashboard.

If the condition is not met in the particular context, the specified tag and it's content will be removed.

HTML and language tagging

• {nbsp} : Is substituted for a non-breaking space when displayed.
• {langx xx}{/langx} : Tag specific text in a particular language by wrapping the text in a plain text pair of {langx xx} {/langx} tags. This makes no visible changes to the content but wraps the content in an HTML <span lang="xx"></span> inline tag. As a result, screen readers will make use of this information to use a particular kind of pronunciation if the text is in a different language than the language of the rest of the page. This is required for compliance with W3C Web Content Accessibility Guidelines (WCAG 2.0)

For more information and an up-to-date list of tags, see the documentation link.