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.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits