AGP Font Awesome Collection

FAQ

How to change the Shortcode content

The plugin includes some templates for each shortcode in “templates/” folder.
You can copy any template in your active theme and customize it for your needs.
Path to the templates folder inside the active theme:

[ActiveTheme]/templates/agp-font-awesome-collection/

How to style the Shortcode content

The plugin includes CSS file “assets/css/style.css”.
You can copy this file in your active theme and customize it for your needs.
Path to the styles inside the active theme:

[ActiveTheme]/templates/agp-font-awesome-collection/assets/css/style.css

How to use “Simple Icon” shortcode

Following shortcode can be used for adding of a simple icon:

[fac_icon icon="camera"]

• icon – Font Awesome icon name without “fa-” prefix

Shortcode with additional attributes:

[fac_icon icon="camera" font_size="20px" color="#ff0000"]

• font_size – allow to set icon size, positive digital value with “px”
• color – allow to set icon color with HEX color value

How to use “Simple Icon with text and shape” shortcode

Following shortcode can be used for adding of a simple icon with additional text and shape:

[fac_icontext icon="heart" text="Default"]

• icon – Font Awesome icon name without “fa-” prefix
• text – allows to set text value that displays at the right side of the icon

Shortcode with additional attributes:

[fac_icontext icon="heart" text="Default" shape_type="round" shape_bg="#000000" icon_color="ffffff" text_color="000000"]

• shape_type – preset shape type ( square / rounded / round )
• shape_bg – allows to set shape background color with HEX color value
• icon_color – allows to set icon color with HEX color value
• text_color – allows to set text color with HEX color value

As general references you can use Font Awesome official examples: http://fortawesome.github.io/Font-Awesome/examples/ .

As for Font Awesome icon names references you can check following link: http://fortawesome.github.io/Font-Awesome/cheatsheet/ .

How to use “Buttons” shortcode

Following shortcode can be used for adding of a simple icon button:

[fac_button icon="facebook" name="button_1" title="Find Us on Facebook" link="www.facebook.com" target="_blank"]

• icon – Font Awesome icon name without “fa-” prefix
• title – allows to set text for button hover (link “title” attribute)
• link – allows to set link URL
• target – allows to set target attribute for the link URL
• name – allows to set unique button name (link ID attribute); this parameter can be used for development purpose (e.g. JavaScript).

Shortcode with additional attributes for icon button with text:

[fac_button icon="facebook" name="button_1" title="Find Us on Facebook" link=www.facebook.com text=" Find Us on Facebook "]

• text – allows to set text value that displays at the right side of the icon

Shortcode with additional attributes for icon button with text customization:

[fac_button icon="facebook" name="button_1" title="Find Us on Facebook" link=www.facebook.com text=" Find Us on Facebook " background="#0d47a1" color="#ffffff" border_radius="4px" border_width="4px" border_color="#0d47a1"]

• color – allows to set text and icon color with HEX color value
• background – allows to set button background color with HEX color value
• border_width – allows to set button border width, positive digital value with “px”
• border_color – allows to set button border color with HEX color value
• border_radius – allows to set button corner rounding; one positive digital value with “px” allows to set equal corner rounding for all corners. Also can be used following values (for example): border_radius=”10px 0″ – corner rounding for left-top and right-bottom corners and vice versa border_radius=”0 10px” – corner rounding for right-top and left-bottom corners; border_radius=” 10px 0 0″ – corner rounding for left-top corner etc. For more references check “border-radius” CSS property.

How to use the Font Awesome Icons in the WordPress menu

At first, You must enable “Menu Icons” module on the plugin settings page in the Admin Panel. Then go to the Appearance > Menus and select necessary menu. For each menu item you can find additional drop-down list with the FA icons.

(For Developers) How to add “Dropdown list” shortcode

Following shortcode can be used for adding of dropdown with Font Awesome icons list:

[fac_dropdown icon="cc-visa" name="myselectid_1"]

• icon – allows to set Font Awesome icon that shows by default ; use Font Awesome icon name without “fa-” prefix
• name – allows to set unique dropdown name (select ID attribute); this parameter can be used for development purpose (e.g. JavaScript)

Also this shortcode can be used directly in code.

(For Developers) How to add “Current Version” shortcode

Following shortcode can be used for adding of info box with current Font Awesome version:

[fac_version]

(For Developers) How to get access to icons collection?

If you need to have access to object of collection you can use following code:

<?php  $iconRepository = Fac()->getIconRepository(); ?>

This object contains list of the entity of Font Awesome icons collection and access methods for these objects.

You can find general objects access methods below:

• getAll() – allow to get full list of the entity of Font Awesome icons
• findById($id) – allow to get icon entity ($id – icon name)
• getCount() – allows to get total count of icons
• getAllCategories() – allows to get list of icons categories
• getAllByCategory($category) – allows to get list of icons for specified category
• getVersion() – allows to get current Font Awesome version
• etc.

Each icon is an Object and also has properties and methods.
For example, if you need to get and show icon display name (e.g. “adn”), you need to use following code:

<?php echo Fac()->getIconRepository()->findById('adn')->getName(); ?>

As result, will be displayed: “App.net”
For more references you can check realization for “Agp\Plugin\Fac\Persistence\IconRepository” and “Agp\Plugin\Fac\Persistence\IconEntity” classes in plugin code.
Also you can send any questions in plugin support tab.

(For Developers) How to use taxonomy icons in the PHP code?

The first, You must enable “Category Icons” feature on the “Settings” page of plugin in the Admin Panel.
After that You must setup icons and icons position on the terms of taxonomy.

You can get the icon data for a specified term of taxonomy with the following code:

<?php $data = Fac()->getTaxonomyIcons()->getTaxIcon( $term_id ); ?>

where:

• $term_id – term_id of the specified term of taxonomy;
• $data[‘icon’] – stored icon;
• $data[‘position’] – stored icon position.