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 #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK