ssi_welcome

Description

Displays the typical SMF welcome message.

Syntax

mixed ssi_welcome ([string $output_method])


Parameter $output_method

Expected type: String
Description: The output method - 'echo' to display a welcome message or anything else to return an array of user data


Return value

Expected type: Mixed
Description:

Possible types
Allowed values Description
Void If the output method is echo, simply outputs a welcome message and doesn't return anything
Array If the output method isn't echo, returns the $context['user'] array for the current user


Notes

  • If called with a parameter of something other than 'echo', returns an array of user info.
View all versions of this function
Advertisement: