Function __global->is_control_field

Definitions

sources/global3.php

  • Find if a POST field is some kind of special control field rather than interesting standalone data.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field_name string No No required parameter N/A N/A Field to check
$include_email_metafields boolean No No False N/A N/A Consider e-mail metafields as control fields
$include_login_fields boolean No No False N/A N/A Consider login fields as control fields
$extra_boring_fields array No No [] N/A N/A Additional boring fields to skip
$include_password_fields boolean No No False N/A N/A Consider password fields as control fields

Returns

  • If it's a control field
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find if a POST field is some kind of special control field rather than interesting standalone data.
 *
 * @param  string $field_name Field to check
 * @param  boolean $include_email_metafields Consider e-mail metafields as control fields
 * @param  boolean $include_login_fields Consider login fields as control fields
 * @param  array $extra_boring_fields Additional boring fields to skip
 * @param  boolean $include_password_fields Consider password fields as control fields
 * @return boolean If it's a control field
 */
function is_control_field(string $field_name, bool $include_email_metafields = false, bool $include_login_fields = false, array $extra_boring_fields = [], bool $include_password_fields = false) : bool