Function __global->_resolve_catalogue_entry_field

Definitions

sources/catalogues.php

  • Get the standardised details for a catalogue entry field.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field array No No required parameter N/A N/A The field row
$entry_id mixed No No required parameter N/A N/A The ID of the entry we are getting OR the row
$only_field_ids ?array No No required parameter N/A N/A A list of field IDs that we are limiting ourselves to (null: get ALL fields)
&$target array Yes No required parameter N/A N/A Save the result into here
$i integer No No required parameter N/A N/A Position in field list (counting from zero)
$tables_to_scan ?array No No Null N/A N/A Which value tables to look in (null: all)
$lang ?LANGUAGE_NAME No No Null N/A N/A Language codename (null: current user's language)

Preview

Code (PHP)

/**
 * Get the standardised details for a catalogue entry field.
 *
 * @param  array $field The field row
 * @param  mixed $entry_id The ID of the entry we are getting OR the row
 * @param  ?array $only_field_ids A list of field IDs that we are limiting ourselves to (null: get ALL fields)
 * @param  array $target Save the result into here
 * @param  integer $i Position in field list (counting from zero)
 * @param  ?array $tables_to_scan Which value tables to look in (null: all)
 * @param  ?LANGUAGE_NAME $lang Language codename (null: current user's language)
 */

function _resolve_catalogue_entry_field(array $field, $entry_id, ?array $only_field_ids, array &$target, int $i, ?array $tables_to_scan = null, ?string $lang = null)