Function Hook_CMA->get_description

Definitions

sources/content.php

  • Get content description of a content row.
  • 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

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

Preview

Code (PHP)

/**
 * Get content description of a content row.
 *
 * @param  array $row The database row for the content
 * @param  integer $render_type A FIELD_RENDER_* constant
 * @return mixed Content description (string or Tempcode, depending on $render_type)
 */
public function get_description(array $row, int $render_type = 1)