[Tip] Show a flash message in custom module templates

[DennisHermannsen]

I needed to show temporary messages in certain cases (like a "success" message after a POST request) and noticed the "$template\includes\flashmessage.tpl" file. I assumed WHMCS already had a native to show flash messages - and I was right.

After doing some research, I found the "WHMCS\FlashMessages" class. This has two methods; get() and set(). The last methods accepts $text and $type (defaults to "info", but can be "danger", "success" and "warning").

If you need to show a flash message on a custom page for your module, just include the following in your template file wherever the message needs to appear:
 

{include file="$template/includes/flashmessage.tpl"}

This is the required PHP code:

<?php

$flashMessage = new \WHMCS\FlashMessages;
$flashMessage->set('Data submitted!', 'success');

 

Edited March 5 by DennisHermannsen