Function __global->_get_catalogue_entry_field

Definitions

sources/catalogues.php

  • Get the value for the specified field, for the stated catalogue entry.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field_id AUTO_LINK No No required parameter N/A N/A The ID of the field we are getting
$entry_id mixed No No required parameter N/A N/A The ID of the entry we are getting for OR the row
$type ID_TEXT No No short short long N/A The type of field
$only_field_ids ?array No No Null N/A N/A A list of field IDs that we are limiting ourselves to (null: get ALL fields)
$tables_to_scan ?array No No Null N/A N/A Which value tables to look in (null: all)

Returns

  • The row (null: not found)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the value for the specified field, for the stated catalogue entry.
 *
 * @param  AUTO_LINK $field_id The ID of the field we are getting
 * @param  mixed $entry_id The ID of the entry we are getting for OR the row
 * @param  ID_TEXT $type The type of field
 * @set short long
 * @param  ?array $only_field_ids A list of field IDs that we are limiting ourselves to (null: get ALL fields)
 * @param  ?array $tables_to_scan Which value tables to look in (null: all)
 * @return ?array The row (null: not found)
 */
function _get_catalogue_entry_field(int $field_id, $entry_id, string $type = 'short', ?array $only_field_ids = null, ?array $tables_to_scan = null) : ?array