Important Note: The contents of this document applies ONLY to version 5.x.x of Simple:Press. It likely does NOT apply to version 6.x.x (our latest version).
Description
sp_GroupHeaderIcon() – Displays the Icon for the forum group
Usage
sp_GroupHeaderIcon($args=”)
Arguments
$args – list of arguments for controlling display.
Type: (string) (optional)
Default:
tagId => spGroupHeaderIcon%ID%: CSS ID for Div with %ID% being the group number
tagClass => spHeaderIcon: CSS Class for Div
icon => ‘sp_GroupIcon.png: The filename to the icon if empty will use default icon or custom icon created in the Group setup.
echo=> 1: Echo the display. a 0 (zero) will return the information.
Special Notes
In standard supplied Simple:Press themes this is used in the main forum page (spGroupView.php) and is shown before the name of the group, can be used elsewhere on a forum page.
Examples
Display the group icon using defaults.
sp_GroupHeaderIcon();
Display the group icon using the built in align left CSS.
sp_GroupHeaderIcon('tagClass=spHeaderIcon spLeft');;
Actions and Hooks Used in Template Tag
- apply_filters(‘sph_GroupHeaderIcon_args’, $a) – allows modification of the arguments to the template tag. $a contains the parsed arguments.
- apply_filters(‘sph_GroupHeaderIcon’, $out, $a)– allows modification of the display code just prior to being output/returned. $out will contain the html display code.
Changelog
Since Version: 5.0