Function Hook_CMA->get_id_string

Definitions

sources/content.php

  • Get an ID string for a content row. This is not to be used anywhere as an ID, it is designed to be human-readable.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$row array No No required parameter N/A N/A The database row for the content
$render_type integer No No 1 N/A N/A A FIELD_RENDER_* constant

Returns

  • ID string (string or Tempcode, depending on $render_type)
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get an ID string for a content row. This is not to be used anywhere as an ID, it is designed to be human-readable.
 *
 * @param  array $row The database row for the content
 * @param  integer $render_type A FIELD_RENDER_* constant
 * @return mixed ID string (string or Tempcode, depending on $render_type)
 */

public function get_id_string(array $row, int $render_type = 1)