usMessage (function)

Last updated: Fri, May 26, 2023 10:06 am
Return to Knowledgebase

Purpose

The usMessage function in UserSpice is a utility function used to display a message to the user. It stores the message in the session for later retrieval.

Location

users/helpers/us_helpers.php

Parameters

# Parameter Data Type Required Description
1 $msg string Yes The message to be stored in the session.

Further Documentation:

$message = "This is a success message.";
usMessage($message);



In the example above, the usMessage function is called with the $message variable containing the success message. The function stores the message in the session for later retrieval. The message can be retrieved and displayed using the appropriate session handling mechanism in UserSpice.

Note that the usMessage function is typically used in conjunction with other functions or processes in UserSpice to provide feedback or information to the user. The specific usage and handling of the stored messages may vary depending on the context and implementation within the UserSpice application.