Font Awesome

Description

The official way to use Font Awesome Free or Pro icons on your site, brought to you by the Font Awesome team.

Features

Our official plugin lets you use Font Awesome the way you want:

• Use Pro or Free icons.
• Leverage the latest release or a specific version of our icons.
• Choose the tech, either SVG or Web Font.
• Take your pick of loading your icons from our classic Font Awesome CDN, or use Font Awesome Kits – the easiest and most efficient way to use Font Awesome icons on the web.
• Turn on automatic compatibility for Font Awesome Version 4 if you – or your plugins – are still using Version 4 syntax.
• Troubleshoot and resolve issues when multiple versions of Font Awesome are loading on your site from other plugins/themes, which can cause unexpected icon display or technical issues.
• Make things even awesomer using icons from Font Awesome Version 6.
• Use your uploaded icons from your Pro Kits.

How to Use

Install and enable the plugin
(See the Installation tab for details)

Add icons to your pages and posts
Adding icons works in both the block editor and the classic editor.

Once you’ve set up your plugin, you can search and add icons to your pages and posts by choosing the Font Awesome option in the format bar from any text block to open the Icon Chooser. (If you want to search and add Pro icons in the Icon Chooser, you’ll need to use a Pro Kit.)

Or you can use the icon names in shortcodes or HTML. When you use shortcodes, you add the name of the icon and a prefix, where the prefix is the style of icon you want to use. Note that you don’t need to include the fa- part of the name. And if you don’t include any prefix, the icon will default to the Solid style.

The shortcode for an icon looks like this:

[icon name="stroopwafel"]

[icon name="stroopwafel" prefix="fal"]

Get the details on all the shortcode options in the Font Awesome WordPress docs.

You can also use basic HTML with standard Font Awesome syntax, like this:

<i class="fas fa-stroopwafel"></i>

Using Pro Icons and Features
To use a Kit, create a Kit on FontAwesome.com and select “Pro icons” in the settings. Then grab your API Token from your Font Awesome account page to add into the WordPress Kit settings.

To add Pro icons with the CDN, you’ll need to add your domain to the list allowed domains on your Font Awesome account CDN Settings page and use shortcodes or HTML to add the icons into your content.

If you’re using the Icon Chooser, you’ll need to use a Pro Kit. (The CDN can only search and add Free icons – use shortcodes or HTML to add Pro icons when using the CDN).

Troubleshooting with the Plugin
Font Awesome icons are popular, so lots of themes and plugins also load Font Awesome, and sometimes their version can conflict with yours. So we created a way to help you find and prevent those conflicting versions from affecting your icons: The Conflict Detection Scanner.

If the plugin seems to be set up correctly and your icons still aren’t loading and you’re not sure why, head over to the Troubleshoot tab, which has two parts:

• Detect Conflicts with Other Versions of Font Awesome – which lets you start the conflict detection scanner to find versions of Font Awesome loading on your site.
• Versions of Font Awesome Active on Your Site – which shows the results of the scanner and lets you prevent any conflicting versions from loading other versions of Font Awesome on your site.

Get more information about using the scanner for troubleshooting on the Font Awesome WordPress docs.

Configuring

The plugin is set to serve Font Awesome Free icons as a Web Font via the Font Awesome CDN by default. You can change the CDN settings right in the plugin. If you want just the basic Free icons, you probably don’t need to make any changes to the default configuration.

You can get more information about all the available settings and troubleshooting on the Font Awesome WordPress docs.

Upgrading from the Old Versions

If you used the old plugin or are still using Version 3 of Font Awesome, we’ve tried to smooth the upgrade path for you by keeping [icon] shortcode compatibility for Font Awesome 3 names used with the old plugin. But we plan to remove version 3 naming support from this plugin soon so don’t wait too long to update your code!

See Also

The README on GitHub has details for WordPress site owners and developers.

And there are API docs for developers.