wireIconMarkup() function

Render markup for a system icon

It is NOT necessary to specify an icon prefix like “fa-” with the icon name.

Modifiers recognized in the class attribute: lg, fw, 2x, 3x, 4x, 5x, spin, spinner, li, border, inverse, rotate-90, rotate-180, rotate-270, flip-horizontal, flip-vertical, stack, stack-1x, stack-2x

Example

// Outputs: "<i class='fa fa-home'></i>"
echo wireIconMarkup('home');

// Outputs: "<i class='fa fa-home fa-fw fa-lg my-class'></i>"
echo wireIconMarkup('home', 'fw lg my-class');

// Outputs "<i class='fa fa-home fa-fw' id='root-icon'></i>" (3.0.229+ only)
echo wireIconMarkup('home', 'fw id=root-icon');
echo wireIconMarkup('home fw id=root-icon'); // same as above

Usage

// basic usage
$string = wireIconMarkup(string $icon);

// usage with all arguments
$string = wireIconMarkup(string $icon, string $class = '');

Arguments

NameType(s)Description
iconstring

Icon name (currently a font-awesome icon name)

class (optional)string

Any of the following:

  • Additional attributes for class (example: "fw" for fixed width)
  • Your own custom class(es) separated by spaces
  • Any additional attributes in format key="val" key='val' or key=val string (3.0.229+)
  • An optional trailing space to append an &nbsp; to the return icon markup (3.0.229+)
  • Any of the above may also be specified in the $icon argument in 3.0.229+.

Return value

string


Functions methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #520
    In the 520th issue of ProcessWire Weekly we'll check out some of the latest additions to the ProcessWire module's directory, share some highlights from the latest weekly update from Ryan, and more. Read on!
    Weekly.pw / 27 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.