Function Hook_fields_short_trans->get_seo_source_map

Definitions

sources/hooks/systems/fields/short_trans.php

  • Determine what data should be used from this field in SEO.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$val string No No required parameter N/A N/A The value of the field
$field_id integer No No required parameter N/A N/A The ID of the field
$content_type ID_TEXT No No required parameter N/A N/A The content type using this field
$content_id ?ID_TEXT No No Null N/A N/A The ID of the content using this field (null: not using a specific piece of content, such as adding a new entry)

Returns

  • Either a string of the content to use in SEO, or a Tuple of [(string) content to use, (boolean) must use / high priority, (boolean) is a codename]
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Determine what data should be used from this field in SEO.
 *
 * @param  string $val The value of the field
 * @param  integer $field_id The ID of the field
 * @param  ID_TEXT $content_type The content type using this field
 * @param  ?ID_TEXT $content_id The ID of the content using this field (null: not using a specific piece of content, such as adding a new entry)
 * @return mixed Either a string of the content to use in SEO, or a Tuple of [(string) content to use, (boolean) must use / high priority, (boolean) is a codename]
 */
public function get_seo_source_map(string $val, int $field_id, string $content_type, ?string $content_id = null)