Function Hook_content_meta_aware_catalogue_entry->info

Definitions

sources/hooks/systems/content_meta_aware/catalogue_entry.php

  • Get content type details.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$zone ?ID_TEXT No No Null N/A N/A The zone to link through to (null: autodetect)
$get_extended_data boolean No No False N/A N/A Populate additional data that is somewhat costly to compute (add_url, archive_url)
$catalogue_name ?ID_TEXT No No Null N/A N/A Catalogue name for entry (null: unknown / N/A)

Returns

  • Map of content-type info (null: disabled)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get content type details.
 *
 * @param  ?ID_TEXT $zone The zone to link through to (null: autodetect)
 * @param  boolean $get_extended_data Populate additional data that is somewhat costly to compute (add_url, archive_url)
 * @param  ?ID_TEXT $catalogue_name Catalogue name for entry (null: unknown / N/A)
 * @return ?array Map of content-type info (null: disabled)
 */
public function info(?string $zone = null, bool $get_extended_data = false, ?string $catalogue_name = null) : ?array