sp_NoGroupMessage

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_NoGroupMessage() – Displays a Message when no Groups can be displayed

Usage

sp_NoGroupMessage($args=”, $deniedMessage=”, $definedMessage=”)

Arguments

$args – list of arguments for controlling display.
Type: (string) (optional)
Default:
tagId => spNoGroupMessage: CSS ID for Div
tagClass => spMessage: CSS Class for Div
echo=> 1: Echo the display. a 0 (zero) will return the information.

$deniedMessage – Text to  if user denied access.
Type: (string) (optional)
Default: None

$definedMessage – Text to display when no groups are defined.
Type: (string) (optional)
Default: None

Special Notes

In standard supplied Simple:Press themes this is used in the main forum page (spGroupView.php) and is shown if some tries to access a group they do not have permission for or if there have been no groups created yet.

Examples

Display message of “The requested group does not exist or you do not have permission to view it” if someone tried to access an unauthorized group and “No groups have been created yet”  if there are no groups.

sp_NoGroupMessage('tagClass=spMessage', __sp('The requested group does not exist or you do not have permission to view it'), __sp('No groups have been created yet'));

Actions and Hooks Used in Template Tag

  • apply_filters(‘sph_NoGroupMessage_args’, $a) – allows modification of the arguments to the template tag. $a contains the parsed arguments.
  • apply_filters(‘sph_NoGroupMessage’, $out, $a) – allows modification of the display code just prior to being output/returned. $out will contain the html display co

Changelog

Since Version: 5.0

Posted in