Function __global->parse_translated_text

Definitions

sources/lang3.php

  • get_translated_tempcode was asked for a lang entry that had not been parsed into Tempcode yet.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$table ID_TEXT No No required parameter N/A N/A The table name
&$row array Yes No required parameter N/A N/A The database row
$field_name ID_TEXT No No required parameter N/A N/A The field name
$db ?object No No required parameter N/A N/A The database connector to use (null: standard site connector)
$lang ?LANGUAGE_NAME No No required parameter N/A N/A The language (null: uses the current language)
$force boolean No No required parameter N/A N/A Whether to force it to the specified language
$as_admin boolean No No required parameter N/A N/A Whether to force as_admin, even if the content language string isn't stored against an admin (designed for Comcode page caching)

Returns

  • The parsed Comcode (null: the text couldn't be looked up)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * get_translated_tempcode was asked for a lang entry that had not been parsed into Tempcode yet.
 *
 * @param  ID_TEXT $table The table name
 * @param  array $row The database row
 * @param  ID_TEXT $field_name The field name
 * @param  ?object $db The database connector to use (null: standard site connector)
 * @param  ?LANGUAGE_NAME $lang The language (null: uses the current language)
 * @param  boolean $force Whether to force it to the specified language
 * @param  boolean $as_admin Whether to force as_admin, even if the content language string isn't stored against an admin (designed for Comcode page caching)
 * @return ?Tempcode The parsed Comcode (null: the text couldn't be looked up)
 */
function parse_translated_text(string $table, array &$row, string $field_name, ?object $db, ?string $lang, bool $force, bool $as_admin) : ?object