Your Moodle version

Filters: FontAwesome Icon Filter

filter_fontawesome
Maintained by Picture of Usman Asar Usman Asar
If you are using a FontAwsome equipped theme (like Essential, Elegance, Shoehorn, Shoelace, BCU, Bootstrap, Flexibase, Pioneer, UIKit, Evolve-D, Adaptable etc) then this filter will allow you to use FontAwesome icons in your content using the easy syntax rather than typing the whole font embed code.
744
713
17

Font Awesome gives you scalable vector icons that can instantly be customized -- size, color, drop shadow, and anything that can be done with the power of CSS. More info on FontAwesome can be found here.

This filter allows you to add FontAwesome icons to anywhere you have a text box in Moodle. If you use the recommended method the Text box strips them aug automatically. This filter provides a mechanism to allow you to use FontAwesome without the editor stripping out your tags.

Filter Updated: 13th April, 2016 adding 23 new icons that came in FontAwesome version 4.6

Usage

IMPORTANT: This syntax has changed since version 1.0. The latest Font Awesome uses a new methodology for naming If you are upgrading you will need to update your text.

First you will need to find the icon you wish to use. This link provides a full list.

Anywhere you wish to add an icon just surround it with square brackets and type in the icon name. e.g.:

[fa-camera-retro]

If you wish to make the icon larger you can use a multiplier. e.g.:

[fa-camera-retro fa-2x]    or    [fa-camera-retro fa-4x]

If you wish to rotate the icon you can specify how many degrees clockwise. e.g.:

[fa-camera-retro fa-rotate-90]

You can also flip an icon horizontally or vertically. e.g.:

[fa-camera-retro fa-flip-horizontal]    or     [fa-camera-retro fa-flip-vertical]

You can mute the colour to a dull grey. e.g.:

[fa-camera-retro fa-muted]

You can "pull" the icon to the left or right. If it is "pulled" to the left text will wrap to the right. e.g.:

[fa-camera-retro pull-left]

All the settings above can be mixed and matched. For example if I was to type in:

[fa-quote-left fa-4x pull-left fa-muted] Use a few of the new styles together, and you've got easy pull quotes or a great introductory article image. Or spinning icons for loading and refreshing content. Or fun big icons in multi-line buttons. You can combine all of them in any combination to get lots of new possibilities.

I will then see:

Example

Important Note:

Please read the readme file provided with this filter. The filter does not provide FontAwesome, just a way to easily add the icon tags to moodle text boxes without having them stripped. To learn how to add this Font to your moodle site read this blog post.

For this filter to work, your theme must have provided FontAwesome in its core files, currently themes supporting FontAwesome are Essential, Elegance, Shoehorn, Shoelace, UI Kit, Evolve-D & BCU and most of them will be updated to latest version 4.4 of FontAwesome. In case the theme you are using is not updated to the latest FontAwesome, using the updated filter will not break anything, old icons will work, the newly added icons won't simply show up.

Update: New version 4.6 of FontAwesome is out with 23 new icons (Total Icons: 628) , therefore its up to theme developers when they would update their corresponding themes with FontAwesome 4.6 for new icons to work, this filter however can be updated and will show older icons as well where themes haven't been updated, that is why all previous versions since 4.3 are kept in case if you have theme with older version of FontAwesome embedded.

See it in Action:

Check out this open (guest access) moodle course to see some examples of this filter in action:

http://features.demo.moodle.com.au/course/view.php?id=35



Installation:

1: Download any applicable file - By applicable I meant if you are assured of your main theme using/updated to FontAwesome 4.6, then you can download 4.6, else any previous applicable version. Don't worry about using most updated version of this filter, even if your Theme isnt updated, the latest icons wont simply show up, rest older icons will work find. In this case you can always request your theme developer to update the FontAwesome in the theme.

2: Upload the zipped file to moodle > filter

3: Unzip, and log-in as administrator, and plug-in installation wizard will start.

4: It will ask for choosing settings, in that case just keep default "Moodle Auto Format" selected. You can always come back to these settings by going to Site Administration > Plugins > Filters > FontAwesome Icon Filter

Enabling FontAwesome Icon Filter

Once FontAwesome has installed, It wont show up automatically until you actually enable the filter to work in Moodle, for that go to Site Administration > Plugins > Filters > Manage Filters. You'll see FontAwesome Icon Filter in the list, click "ON" where its mentioned disabled in drop down. Using the above format, will start showing up icons where applicable.

More applicable examples of using FontAwesome can be found HERE.

Potential privacy issues

Not Applicable

Screenshots

Screenshot #0
Screenshot #1

Contributors

Picture of Usman Asar
Usman Asar (Lead maintainer)
Julian Ridden
Julian Ridden: Original author
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Heinz Schmolke
    Fri, Dec 27, 2013, 3:49 AM
    The same with me: If I put the directory in filters I got a error: "Trying to reference an unknown block region side-post". The filter do not work in 2.5
  • Picture of Caitlin Cahill
    Thu, May 15, 2014, 5:04 AM
    Great filter! It works beautifully on webpages, but does not work on a database template.
  • Work Photo 2014
    Fri, Nov 28, 2014, 12:05 AM
    Brilliant idea... I see the latest download is for 2.6 does it work with 2.7 and 2.8?
  • Picture of David Mudrák
    Wed, Dec 10, 2014, 4:30 AM
    This unmaintained plugin has been adopted by Usman Asar. Thanks a lot, and good luck with further development of it!
  • Picture of Chris Mat
    Wed, May 27, 2015, 4:39 PM
    Hi Usman,

    Are you going to upgrade to 2.9?
  • Picture of Usman Asar
    Wed, May 27, 2015, 5:25 PM
    Chris, usually filters are compatible across all Moodle versions without any dependencies. Thanks for the reminder (should have done it long ago), Moodle version updated for compatibility.
  • Picture of Brendan Heywood
    Thu, Aug 20, 2015, 11:33 AM
    hi Usman,

    Can you please share the latest git repo in the plugin metadata, it is out of sync with the zip downloads, thanks smile
  • Ricardo Caiado
    Wed, Apr 13, 2016, 8:53 PM
    Hi,

    Got this log error message when I try to upgrade to v4.6:

    "...PHP Notice: Invalid get_string() identifier: 'configrequiremodintro' or component 'admin'. Perhaps you are missing $string['configrequiremodintro'] = ''; in lang/en/admin.php?
    • line 349 of /lib/classes/string_manager_standard.php: call to debugging()
    • line 6675 of /lib/moodlelib.php: call to core_string_manager_standard->get_string()
    • line 36 of /mod/grouptool/settings.php: call to get_string()
    • line 89 of /lib/classes/plugininfo/mod.php: call to include()
    • line 45 of /admin/settings/plugins.php: call to core\\plugininfo\\mod->load_settings()
    • line 6933 of /lib/adminlib.php: call to require()
    • line 784 of /admin/index.php: call to admin_get_root()
    in XXXXX/lib/weblib.php on line 2934, referer: http://XXXXX/admin/plugins.php"

    Any ideas?

    Ricardo
  • Picture of Usman Asar
    Wed, Apr 13, 2016, 10:55 PM
    Hello Ricardo,

    I have upgraded to plenty instances without any of them showing issues, which version of Moodle you're using? also, can you uninstall and re-install to see if the issue remains there?
  • Ricardo Caiado
    Thu, Apr 14, 2016, 2:47 AM
    Moodle 3.0.3

    from 4.5 (Build: 20160130) to 4.6 (Build: 20160413)

    Ok, I will try that.

  • Ricardo Caiado
    Thu, Apr 14, 2016, 3:00 AM
    Something is wrong...

    Just downloaded "filter_fontawesome_moodle30_2016041300".

    "version.php"
    -----------------
    ...
    $plugin->version = 2016013000; // The current plugin version (Date: YYYYMMDDXX)
    $plugin->maturity = MATURITY_STABLE; // this version's maturity level.
    $plugin->release = '4.5 (Build: 20160130)'; <<<========================================================
    $plugin->requires = 2013050100; // Requires this Moodle version
    $plugin->component = 'filter_fontawesome'; // Full name of the plugin (used for diagnostics)
    ...
    -----------------

    Is it right?

  • Picture of Usman Asar
    Thu, Apr 14, 2016, 10:37 AM
    Ricardo, Just made changes to version file, thanks for reporting, please download again.
    Thanks!
  • Ricardo Caiado
    Thu, Apr 14, 2016, 9:33 PM
    Worked!
  • Picture of Matt Townend
    Mon, Sep 5, 2016, 1:10 PM
    Hey I found that this works fine in text content but not in headings and course names, category names etc. I am using Archaius Theme with added. Anyone else find this problem?
  • Picture of Usman Asar
    Mon, Sep 5, 2016, 5:17 PM
    Matt, you have to do two things
    1: Go into Site administration > Appearance > HTML Settings ---- Default setting is CHECKED for remove HTML tags from all activity names, uncheck that (means you are selecting NO).
    2: Next, go to Plug-Ins > Filters > Manage Filters and in FontAwesome icon filter, select "content & headings" in Apply to section.

    You're done! feel free to fill up headings, section names with icons, I am not still sure about course names if that works there too, but no harm giving a try, if it didn't, try using the exact code from fontawesome rather than filtered code.
1 2
Please login to post comments