Function __global->get_translated_tempcode

Definitions

sources/lang.php

  • This function is an offshoot of get_translated_text, it instead returns parsed Comcode that is linked to the specified content language string ID.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$table ID_TEXT required parameter N/A N/A The table name
$row array required parameter N/A N/A The table row. Must not have aspects of other tables in it (i.e. joins). Pre-filter using 'db_map_restrict' if required
$field_name ID_TEXT required parameter N/A N/A The field name
$db ?object Null N/A N/A The database connector to use (null: standard site connector)
$lang ?LANGUAGE_NAME Null N/A N/A The language (null: uses the current language)
$force boolean False N/A N/A Whether to force it to the specified language
$as_admin boolean False 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)
$clear_away_from_cache boolean False N/A N/A Whether to remove from the Tempcode cache when we're done, for performance reasons (normally don't bother with this, but some code knows it won't be needed again -- esp Comcode cache layer -- and saves RAM by removing it)
$ignore_browser_decaching boolean False N/A N/A If we have just re-populated so will not decache

Return

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