Fieldmanager_Context

abstract class Fieldmanager_Context (View source)

Base class for contexts.

Contexts dictate where fields appear, how they load data, and where they save data.

Properties

Fieldmanager_Field $fm

The base field associated with this context.
string $uniqid

Unique ID of the form. Used for forms that are not built into WordPress.
array $save_keys

Store the meta keys this field saves to, to catch naming conflicts.

Methods

__construct()

Instantiate this context.

string
nonce_key()

Get the nonce key for this field.

array
refresh_nonce(array $response)

Include a fresh nonce for this field in a response with refreshed nonces.

bool
is_valid_nonce()

Check if the nonce is valid. Returns false if the nonce is missing and throws an exception if it's invalid. If all goes well, returns true.

mixed
prepare_data(mixed $old_value = null, mixed $new_value = null, object $fm = null)

Prepare the data for saving.

string
render_field(array $args = array())

Render the field.

Details

at line 40
__construct()

Instantiate this context.

at line 50
protected string nonce_key()

Get the nonce key for this field.

Return Value

string

at line 62
array refresh_nonce(array $response)

Since: 1.3.0

Include a fresh nonce for this field in a response with refreshed nonces.

Parameters

array $response

Response data.

Return Value

array

Updated response data.

at line 74
protected bool is_valid_nonce()

Check if the nonce is valid. Returns false if the nonce is missing and throws an exception if it's invalid. If all goes well, returns true.

Return Value

bool

at line 95
protected mixed prepare_data(mixed $old_value = null, mixed $new_value = null, object $fm = null)

Prepare the data for saving.

Parameters

mixed $old_value

Optional. The previous value.
mixed $new_value

Optional. The new value for the field.
object $fm

Optional. The Fieldmanager_Field to prepare.

Return Value

mixed

The filtered and sanitized value, safe to save.

at line 122
protected string render_field(array $args = array())

Render the field.

Parameters

array $args

{ Optional. Arguments to adjust the rendering behavior.

@type mixed $data The existing data to display with the field. If
                  absent, data will be loaded using
                  Fieldmanager_Context::_load().
@type boolean $echo Output if true, return if false. Default is true.

}

Return Value

string

if $args['echo'] == false.