Function Hook_fields_email->get_field_inputter

Definitions

sources/hooks/systems/fields/email.php

  • Get form inputter.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$_cf_name string No No required parameter N/A N/A The field name
$_cf_description string No No required parameter N/A N/A The field description
$field array No No required parameter N/A N/A The field details
$actual_value ?string No No required parameter N/A N/A The actual current value of the field (null: none)
$new boolean No No required parameter N/A N/A Whether this is for a new entry

Returns

  • The Tempcode for the input field (null: skip the field - it's not input)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get form inputter.
 *
 * @param  string $_cf_name The field name
 * @param  string $_cf_description The field description
 * @param  array $field The field details
 * @param  ?string $actual_value The actual current value of the field (null: none)
 * @param  boolean $new Whether this is for a new entry
 * @return ?Tempcode The Tempcode for the input field (null: skip the field - it's not input)
 */
public function get_field_inputter(string $_cf_name, string $_cf_description, array $field, ?string $actual_value, bool $new) : ?object