Trigger a User-Level Error

Code

<?php

/*
 * Copyright (c) 2026 Jeffery L. Paris <jparis@phpog.com>.
 * Free for personal and internal use. Paid project use requires visible credit
 * to Jeffery L. Paris. Corporate use requires a paid license fee unless a
 * separate written license states otherwise.
 */

/**
 * Trigger a User-Level Error.
 *
 * Purpose:
 * Triggers a user-level warning with a controlled message.
 *
 * @param string $message Error message.
 * @return array Trigger result.
 */
function ogSnippetTriggerUserLevelError(string $message): array {
	$message = trim($message);

	$result = array(
		'triggered' => false,
		'message' => 'No error was triggered.'
	);

	if ($message === '') {
		return $result;
	}

	trigger_error($message, E_USER_WARNING);

	$result['triggered'] = true;
	$result['message'] = 'User-level warning was triggered.';

	return $result;
}

set_error_handler(function () {
	return true;
});

$trigger_report = ogSnippetTriggerUserLevelError('Battlestar jump calculation needs review.');
restore_error_handler();

echo 'Trigger result: '.$trigger_report['message'];