PHPDoc: lang_get() can also return an array

When retrieving 'MANTIS_ERROR'.
mantisbt · Feb 7, 2018 · 62471c7 · 62471c7
1 parent bcb801b
commit 62471c7
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/core/lang_api.php b/core/lang_api.php
@@ -263,9 +263,10 @@ function lang_get_current() {
  * This function will return one of (in order of preference):
  *  1. The string in the current user's preferred language (if defined)
  *  2. The string in English
+ * Note: when $p_string is 'MANTIS_ERROR', the return value is an array of error messages.
  * @param string $p_string The language string to retrieve.
  * @param string $p_lang   The language name.
- * @return string
+ * @return string|array
  */
 function lang_get( $p_string, $p_lang = null ) {
 	global $g_lang_strings;