Function Hook_fields_short_trans->inputted_to_field_value

Definitions

sources/hooks/systems/fields/short_trans.php

  • Find the posted value from the get_field_inputter field.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$editing boolean No No required parameter N/A N/A Whether we were editing (because on edit, it could be a fractional edit)
$field array No No required parameter N/A N/A The field details
$upload_dir ?string No No uploads/catalogues N/A N/A Where the files will be uploaded to (null: do not store an upload, return null if we would need to do so)
$old_value ?array No No Null N/A N/A Former value of field (null: none)

Returns

  • The value (null: could not process)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find the posted value from the get_field_inputter field.
 *
 * @param  boolean $editing Whether we were editing (because on edit, it could be a fractional edit)
 * @param  array $field The field details
 * @param  ?string $upload_dir Where the files will be uploaded to (null: do not store an upload, return null if we would need to do so)
 * @param  ?array $old_value Former value of field (null: none)
 * @return ?string The value (null: could not process)
 */
public function inputted_to_field_value(bool $editing, array $field, ?string $upload_dir = 'uploads/catalogues', ?array $old_value = null) : ?string