Fieldmanager_Context_QuickEdit

class Fieldmanager_Context_QuickEdit extends Fieldmanager_Context_Storable (View source)

Use fieldmanager to add fields to the "quick edit" (post list inline editing) and save data primarily to post meta.

Properties

Fieldmanager_Field $fm

Base field
string $uniqid

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

 from  Fieldmanager_Context
array $save_keys

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

 from  Fieldmanager_Context
array $taxonomies_to_save

Taxonomies to save to.

 from  Fieldmanager_Context_Storable
string $title

Title of QuickEdit box; also used for the column title unless $column_title is specified.
string $column_title

Override $title for the column in the list of posts.
callable $column_display_callback

QuickEdit fields are tied to custom columns in the list of posts. This callback should return a value to display in a custom column.
string $post_types

What post types to render this Quickedit form.

Methods

__construct(string $title, mixed $post_types, callable $column_display_callback, callable $column_title = '', Fieldmanager_Field $fm = null)

Add a context to a fieldmanager.

string
nonce_key()

Get the nonce key for this field.

from  Fieldmanager_Context
array
refresh_nonce(array $response)

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

from  Fieldmanager_Context
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.

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

Prepare the data for saving.

from  Fieldmanager_Context
string
render_field(array $args = array())

Render the field.

from  Fieldmanager_Context_Storable
save(mixed $data = null)

Handle saving data for any context.

from  Fieldmanager_Context_Storable
save_field(object $field, mixed $data)

Save a single field.

from  Fieldmanager_Context_Storable
save_walk_children(object $field, mixed $data)

Walk group children to save when serialize_data => false.

from  Fieldmanager_Context_Storable
mixed
load()

Handle loading data for any context.

from  Fieldmanager_Context_Storable
mixed
load_field(object $field)

Load a single field.

from  Fieldmanager_Context_Storable
mixed
load_walk_children(object $field)

Walk group children to load when serialize_data => false.

from  Fieldmanager_Context_Storable
static string|array
sanitize_scalar_value(mixed $value)

Meta and options are always stored as strings, so it's best to ensure that scalar values get cast as strings to ensure that update_metadata() and update_option() are able to correctly compare the current value against the previous value.

from  Fieldmanager_Context_Storable
string|array
get_data(int $post_id, string $meta_key, bool $single = false)

Get post meta.

bool|int
add_data(int $post_id, string $meta_key, mixed $meta_value, bool $unique = false)

Add post meta.

mixed
update_data(int $post_id, string $meta_key, mixed $meta_value, mixed $data_prev_value = '')

Update post meta.

bool
delete_data(int $post_id, string $meta_key, mixed $meta_value = '')

Delete post meta.

array
add_custom_columns(array $columns)

Callback for manage_{$post_type}_posts_columns, as QuickEdit boxes only work on custom columns.

manage_custom_columns(string $column_name, int $post_id)

The manage_posts_custom_column callback.

add_quickedit_box(string $column_name, string $post_type, array $values = array())

The quick_edit_custom_box callback. Renders the QuickEdit box.

render_ajax_form()

Callback for wp_ajax_fm_quickedit_render.

save_fields_for_quickedit(int $post_id)

Takes $_POST data and saves it to, calling save_to_post_meta() once validation is passed When using Fieldmanager as an API, do not call this function directly, call save_to_post_meta().

save_to_post_meta(int $post_id, array $data = null)

Helper to save an array of data to post meta.

Details

at line 61
__construct(string $title, mixed $post_types, callable $column_display_callback, callable $column_title = '', Fieldmanager_Field $fm = null)

Add a context to a fieldmanager.

Parameters

string $title

Title of the form.
mixed $post_types

Post types to show form on.
callable $column_display_callback

Display callback.
callable $column_title

Column title.
Fieldmanager_Field $fm

The base field.

Exceptions

FM_Developer_Exception

in Fieldmanager_Context at line 50
protected string nonce_key()

Get the nonce key for this field.

Return Value

string

in Fieldmanager_Context 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.

in Fieldmanager_Context 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

in Fieldmanager_Context 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.

in Fieldmanager_Context_Storable at line 33
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.

in Fieldmanager_Context_Storable at line 46
protected save(mixed $data = null)

Handle saving data for any context.

Parameters

mixed $data

Data to save. Should be raw, e.g. POST data.

in Fieldmanager_Context_Storable at line 109
protected save_field(object $field, mixed $data)

Save a single field.

Parameters

object $field

Fieldmanager field.
mixed $data

Data to save.

Exceptions

FM_Developer_Exception

in Fieldmanager_Context_Storable at line 140
protected save_walk_children(object $field, mixed $data)

Walk group children to save when serialize_data => false.

Parameters

object $field

Fieldmanager field.
mixed $data

Data to save.

in Fieldmanager_Context_Storable at line 158
protected mixed load()

Handle loading data for any context.

Return Value

mixed

The loaded data.

in Fieldmanager_Context_Storable at line 172
protected mixed load_field(object $field)

Load a single field.

Parameters

object $field

The Fieldmanager field for which to load data.

Return Value

mixed

Data stored for that field in this context.

in Fieldmanager_Context_Storable at line 188
protected mixed load_walk_children(object $field)

Walk group children to load when serialize_data => false.

Parameters

object $field

Fieldmanager field for which to load data.

Return Value

mixed

Data stored for a singular field with serialized data, or array of data for a groups's children.

in Fieldmanager_Context_Storable at line 212
static string|array sanitize_scalar_value(mixed $value)

Since: 1.2.0

Meta and options are always stored as strings, so it's best to ensure that scalar values get cast as strings to ensure that update_metadata() and update_option() are able to correctly compare the current value against the previous value.

Parameters

mixed $value

Value being stored.

Return Value

string|array

If $value is scalar, a string is returned. Otherwise, $value returns untouched.

at line 271
protected string|array get_data(int $post_id, string $meta_key, bool $single = false)

Get post meta.

Parameters

int $post_id

Post ID.
string $meta_key

Optional. The meta key to retrieve. By default, returns data for all keys. Default empty.
bool $single

Optional. If true, only returns the first value found for the given data_key. This won't apply to every context. Default is false.

Return Value

string|array

The stored data. If no data is found, should return an empty string (""). {\get_post_meta()}.

See also

get_post_meta().

at line 286
protected bool|int add_data(int $post_id, string $meta_key, mixed $meta_value, bool $unique = false)

Add post meta.

Parameters

int $post_id

Post ID.
string $meta_key

Metadata name.
mixed $meta_value

Metadata value. Must be serializable if non-scalar.
bool $unique

Optional. If true, data will only be added if the object with the given $data_id doesn't already contain data for the given $data_key. This may not apply to every context. Default is false.

Return Value

bool|int

On success, should return the ID of the stored data (an integer, which will evaluate as true). If the $unique argument is set to true and data with the given key already exists, this should return false. {\add_post_meta()}.

See also

add_post_meta().

at line 301
protected mixed update_data(int $post_id, string $meta_key, mixed $meta_value, mixed $data_prev_value = '')

Update post meta.

Parameters

int $post_id

Post ID.
string $meta_key

Metadata key.
mixed $meta_value

Metadata value. Must be serializable if non-scalar.
mixed $data_prev_value

Optional. Only update data if the previous value matches the data provided. This may not apply to every context.

Return Value

mixed

Should return data id if the data doesn't exist, otherwise should return true on success and false on failure. If the value passed to this method is the same as the stored value, this method should return false. {\update_post_meta()}.

See also

update_post_meta().

at line 316
protected bool delete_data(int $post_id, string $meta_key, mixed $meta_value = '')

Delete post meta.

Parameters

int $post_id

Post ID.
string $meta_key

Metadata name.
mixed $meta_value

Optional. Metadata value. Must be serializable if non-scalar. Default empty.

Return Value

bool

False for failure. True for success. {\delete_post_meta()}.

See also

delete_post_meta().

at line 111
array add_custom_columns(array $columns)

Callback for manage_{$post_type}_posts_columns, as QuickEdit boxes only work on custom columns.

Parameters

array $columns

The custom columns.

Return Value

array

$columns The custom columns.

at line 122
manage_custom_columns(string $column_name, int $post_id)

The manage_posts_custom_column callback.

Parameters

string $column_name

Column name.
int $post_id

The post ID.

at line 142
add_quickedit_box(string $column_name, string $post_type, array $values = array())

The quick_edit_custom_box callback. Renders the QuickEdit box.

Renders with blank values here since QuickEdit boxes cannot access to the WP post_id. The values will be populated by an ajax-fetched form later (see $this->render_ajax_form() ).

Parameters

string $column_name

The column name.
string $post_type

The post type to show the column.
array $values

The current values.

at line 170
render_ajax_form()

Callback for wp_ajax_fm_quickedit_render.

Renders a form with pre-filled values to replace the one generated by $this->add_quickedit_box().

at line 207
save_fields_for_quickedit(int $post_id)

Takes $_POST data and saves it to, calling save_to_post_meta() once validation is passed When using Fieldmanager as an API, do not call this function directly, call save_to_post_meta().

Parameters

int $post_id

The post ID.

at line 254
save_to_post_meta(int $post_id, array $data = null)

Helper to save an array of data to post meta.

Parameters

int $post_id

The post ID.
array $data

The post data.