Property | Type | Description | |
---|---|---|---|
$display_errors | boolean | ||
$fields | |||
$format | |||
$instance | PodsAPI | ||
$instances | PodsAPI | ||
$pod | |||
$pod_data | array | boolean | mixed | null | void | ||
$pod_id |
Method | Description | |
---|---|---|
__call ( $name, $args ) | Handle methods that have been deprecated | |
__construct ( string $pod = null, string $format = null ) : PodsAPI | Store and retrieve data programatically | |
__get ( $name ) | Handle variables that have been deprecated | |
add_pod ( array $params ) : boolean | integer | ||
cache_flush_pods ( array $pod = null ) : void | Clear Pod-related cache | |
csv_to_php ( string $data, $delimiter = ',' ) : array | Convert CSV to a PHP array | |
delete_field ( array $params, boolean $table_operation = true ) : boolean | Drop a field within a Pod | |
delete_helper ( array $params ) : boolean | ||
delete_object ( array | object $params ) : boolean | Drop a Pod Object | |
delete_object_from_relationships ( integer $id, $object, string $name = null ) : boolean | Delete an object from tableless fields | |
delete_page ( array $params ) : boolean | ||
delete_pod ( array $params, boolean $strict = false, boolean $delete_all = false ) : boolean | Delete a Pod and all its content | |
delete_pod_item ( array $params, boolean $wp = true ) : boolean | Drop a single pod item | |
delete_relationships ( integer | array $related_id, integer | array $id, array $related_pod, array $related_field ) : void | Delete relationships | |
delete_template ( array $params ) : boolean | ||
delete_wp_object ( string $object_type, integer $id, boolean $force_delete = true ) : boolean | mixed | Delete a WP object | |
detect_pod_field_from_sql_data_type ( string $sql_field ) : string | Takes a sql field such as tinyint and returns the pods field type, such as num. | |
duplicate_field ( array $params, boolean $strict = false ) : integer | Duplicate a Field | |
duplicate_pod ( array $params, boolean $strict = false ) : integer | Duplicate a Pod | |
duplicate_pod_item ( array $params ) : integer | ||
export ( string | object $pod = null, array $params = null ) : array | Export data from a Pod | |
export_package ( array $params ) : array | boolean | Export a package | |
export_pod_item ( array $params, object $pod = null ) : integer | ||
field_exists ( array $params ) : boolean | Check if a Pod's field exists | |
get_changed_fields ( array $pieces ) : array | Get the fields that have changed during a save | |
get_current_language ( ) : array | Get current language information from Multilingual plugins | |
get_field_types ( ) : array | Gets all field types | |
get_pod_type_count ( string $type ) : integer | Get number of pods for a specific pod type | |
get_table_info ( string $object_type, string $object, null $name = null, array $pod = null, array $field = null ) : array | boolean | Get information about an objects MySQL table | |
get_table_info_load ( $object_type, string $object, null $name = null, array $pod = null ) : array | Load the information about an objects MySQL table | |
get_wp_object_fields ( string $object = 'post_type', array $pod = null, boolean $refresh = false ) : array | Get a list of core WP object fields for a specific object | |
handle_field_validation ( mixed &$value, string $field, array $object_fields, array $fields, array | Pods $pod, array | object $params ) : array | boolean | ||
import ( mixed $import_data, boolean $numeric_mode = false, string $format = null ) : array | Import data from an array or a CSV file. | |
import_package ( mixed $data = false, boolean $replace = false ) : boolean | Import a package | |
init ( string $pod = null, string $format = null ) : PodsAPI | Singleton-ish handling for a basic pods_api() request | |
load_field ( array $params, boolean $strict = false ) : array | boolean | Load a field | |
load_fields ( array $params, boolean $strict = false ) : array | Load fields by Pod, ID, Name, and/or Type | |
load_helper ( array $params ) : array | boolean | ||
load_helpers ( array $params = null ) : array | ||
load_object ( array | object $params, boolean $strict = false ) : array | boolean | Load a Pods Object | |
load_objects ( array | object $params ) : array | Load Multiple Pods Objects | |
load_page ( array $params ) : array | boolean | ||
load_pages ( array $params = null ) : array | ||
load_pod ( array | object $params, boolean $strict = true ) : array | boolean | mixed | void | Load a Pod and all of its fields | |
load_pod_item ( array $params ) : boolean | Pods | Load the pod item object | |
load_pods ( array $params = null ) : array | mixed | Load a list of Pods based on filters specified. | |
load_sister_fields ( array $params, array $pod = null ) : array | boolean | Load potential sister fields for a specific field | |
load_template ( array $params ) : array | boolean | ||
load_templates ( array $params = null ) : array | ||
lookup_related_items ( integer $field_id, integer $pod_id, mixed $ids, array $field = null, array $pod = null ) : array | Find items related to a parent field | |
lookup_related_items_from ( integer $field_id, integer $pod_id, integer $id, array $field = null, array $pod = null ) : array | boolean | Find related items related to an item | |
pod_exists ( array $params, $type = null ) : boolean | Check if a Pod exists | |
process_form ( mixed $params, object $obj = null, array $fields = null, string $thank_you = null ) : mixed | Process a Pod-based form | |
rename_wp_object_type ( string $object_type, string $old_name, string $new_name ) : boolean | Rename a WP object's type | |
reorder_pod_item ( array $params ) : boolean | Reorder a Pod | |
replace_package ( mixed $data = false ) : boolean | Replace an existing package | |
reset_pod ( array $params, array $pod = false ) : boolean | Delete all content for a Pod | |
save_comment ( array $comment_data, array $comment_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | Save a comment and it's meta | |
save_comment_meta ( integer $id, array $comment_meta = null, boolean $strict = false, array $fields = [] ) : integer | Save a comment meta | |
save_field ( array $params, boolean $table_operation = true, boolean $sanitized = false, boolean | integer $db = true ) : integer | array | Add or edit a field within a Pod | |
save_helper ( array $params, boolean $sanitized = false ) : integer | ||
save_object ( array | object $params, boolean $sanitized = false ) : integer | Add or Edit a Pods Object | |
save_page ( array | object $params, boolean $sanitized = false ) : integer | ||
save_pod ( array $params, boolean $sanitized = false, boolean | integer $db = true ) : integer | Add or edit a Pod | |
save_pod_item ( array | object $params ) : integer | Add or edit a single pod item | |
save_pod_items ( array | object $params, array $data ) : integer | ||
save_post ( array $post_data, array $post_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : mixed | void | Save a post and it's meta | |
save_post_meta ( integer $id, array $post_meta = null, boolean $strict = false, array $fields = [] ) : integer | Save a post's meta | |
save_relationships ( integer $id, $related_ids, array $pod, array $field ) | Save relationships | |
save_setting ( string $setting, array $option_data, boolean $sanitized = false ) : boolean | Save a set of options | |
save_slug_fix ( string $slug, integer $post_ID, string $post_status, string $post_type, integer $post_parent, string $original_slug = null ) : string | Fix Pod / Field post_name to ensure they are exactly as saved (allow multiple posts w/ same post_name) | |
save_template ( array | object $params, boolean $sanitized = false ) : integer | ||
save_term ( array $term_data, array $term_meta, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | Save a taxonomy's term | |
save_term_meta ( integer $id, array $term_meta = null, boolean $strict = false, array $fields = [] ) : integer | Save a term's meta | |
save_user ( array $user_data, array $user_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | Save a user and it's meta | |
save_user_meta ( integer $id, array $user_meta = null, boolean $strict = false, array $fields = [] ) : integer | Save a user meta | |
save_wp_object ( string $object_type, array $data, array $meta = [], boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : boolean | mixed | Save a WP object and its meta | |
validate_package ( array | string $data = false, boolean $output = false ) : array | boolean | Validate a package |
Method | Description | |
---|---|---|
do_hook ( ) | Handle filters / actions for the class | |
export_pod_item_level ( Pods $pod, array $fields, integer $depth, boolean $flatten = false, integer $current_depth = 1 ) : array | Export a pod item by depth level | |
get_field_definition ( string $type, array $options = null ) : array | boolean | mixed | null | Gets the schema definition of a field. |
public __construct ( string $pod = null, string $format = null ) : PodsAPI | ||
$pod | string | (optional) The pod name |
$format | string | (deprecated) Format for import/export, "php" or "csv" |
return | PodsAPI |
public cache_flush_pods ( array $pod = null ) : void | ||
$pod | array | |
return | void |
public csv_to_php ( string $data, $delimiter = ',' ) : array | ||
$data | string | The CSV input |
return | array |
public delete_helper ( array $params ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean |
public delete_page ( array $params ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean |
public delete_pod ( array $params, boolean $strict = false, boolean $delete_all = false ) : boolean | ||
$params | array | An associative array of parameters |
$strict | boolean | (optional) Makes sure a pod exists, if it doesn't throws an error |
$delete_all | boolean | (optional) Whether to delete all content from a WP object |
return | boolean |
public delete_template ( array $params ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean |
public static detect_pod_field_from_sql_data_type ( string $sql_field ) : string | ||
$sql_field | string | The SQL field to look for |
return | string | The field type |
public duplicate_pod_item ( array $params ) : integer | ||
$params | array | An associative array of parameters |
return | integer | The table row ID |
public field_exists ( array $params ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean |
public get_changed_fields ( array $pieces ) : array | ||
$pieces | array | Pieces array from save_pod_item |
return | array | Array of fields and values that have changed |
public static get_current_language ( ) : array | ||
return | array |
public get_field_types ( ) : array | ||
return | array | Array of field types |
public get_pod_type_count ( string $type ) : integer | ||
$type | string | Type to get count |
return | integer | Total number of pods for a type |
public get_table_info ( string $object_type, string $object, null $name = null, array $pod = null, array $field = null ) : array | boolean | ||
$object_type | string | |
$object | string | The object to look for |
$name | null | (optional) Name of the pod to load |
$pod | array | (optional) Array with pod information |
$field | array | (optional) Array with field information |
return | array | boolean |
public get_wp_object_fields ( string $object = 'post_type', array $pod = null, boolean $refresh = false ) : array | ||
$object | string | The pod type to look for, possible values: post_type, user, comment, taxonomy |
$pod | array | Array of Pod data |
$refresh | boolean | Whether to force refresh the information |
return | array | Array of fields |
public handle_field_validation ( mixed &$value, string $field, array $object_fields, array $fields, array | Pods $pod, array | object $params ) : array | boolean | ||
$value | mixed | The value to validate |
$field | string | Field to use for validation |
$object_fields | array | Fields of the object we're validating |
$fields | array | Array of all fields data |
$pod | array | Pods | Array of pod data (or Pods object) |
$params | array | object | Extra parameters to pass to the validation function of the field. |
return | array | boolean |
public import ( mixed $import_data, boolean $numeric_mode = false, string $format = null ) : array | ||
$import_data | mixed | PHP associative array or CSV input |
$numeric_mode | boolean | Use IDs instead of the name field when matching |
$format | string | Format of import data, options are php or csv |
return | array | IDs of imported items |
public load_helpers ( array $params = null ) : array | ||
$params | array | (optional) An associative array of parameters |
return | array |
public load_pages ( array $params = null ) : array | ||
$params | array | (optional) An associative array of parameters |
return | array |
public load_pod_item ( array $params ) : boolean | Pods | ||
$params | array | An associative array of parameters |
return | boolean | Pods |
public load_templates ( array $params = null ) : array | ||
$params | array | (optional) An associative array of parameters |
return | array |
public pod_exists ( array $params, $type = null ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean | True if exists |
public reorder_pod_item ( array $params ) : boolean | ||
$params | array | An associative array of parameters |
return | boolean |
public replace_package ( mixed $data = false ) : boolean | ||
$data | mixed | (optional) An associative array containing a package, or the json encoded package |
return | boolean |
public save_comment ( array $comment_data, array $comment_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | ||
$comment_data | array | All comment data to be saved (using wp_insert_comment / wp_update_comment) |
$comment_meta | array | (optional) All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $comment_meta |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Comment ID |
public save_comment_meta ( integer $id, array $comment_meta = null, boolean $strict = false, array $fields = [] ) : integer | ||
$id | integer | Comment ID |
$comment_meta | array | (optional) All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $comment_meta |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Comment ID |
public save_field ( array $params, boolean $table_operation = true, boolean $sanitized = false, boolean | integer $db = true ) : integer | array | ||
$params | array | An associative array of parameters |
$table_operation | boolean | (optional) Whether or not to handle table operations |
$sanitized | boolean | (optional) Decides wether the params have been sanitized before being passed, will sanitize them if false. |
$db | boolean | integer | (optional) Whether to save into the DB or just return field array. |
return | integer | array | The field ID or field array (if !$db) |
public save_pod ( array $params, boolean $sanitized = false, boolean | integer $db = true ) : integer | ||
$params | array | An associative array of parameters |
$sanitized | boolean | (optional) Decides whether the params have been sanitized before being passed, will sanitize them if false. |
$db | boolean | integer | (optional) Whether to save into the DB or just return Pod array. |
return | integer | Pod ID |
public save_post ( array $post_data, array $post_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : mixed | void | ||
$post_data | array | All post data to be saved (using wp_insert_post / wp_update_post) |
$post_meta | array | (optional) All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $post_meta |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | mixed | void |
public save_post_meta ( integer $id, array $post_meta = null, boolean $strict = false, array $fields = [] ) : integer | ||
$id | integer | Post ID |
$post_meta | array | All meta to be saved (set value to null to delete) |
$strict | boolean | Whether to delete previously saved meta not in $post_meta |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Id of the post with the meta |
public save_setting ( string $setting, array $option_data, boolean $sanitized = false ) : boolean | ||
$setting | string | Setting group name |
$option_data | array | All option data to be saved |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
return | boolean |
public save_slug_fix ( string $slug, integer $post_ID, string $post_status, string $post_type, integer $post_parent, string $original_slug = null ) : string | ||
$slug | string | Unique slug value |
$post_ID | integer | Post ID |
$post_status | string | Post Status |
$post_type | string | Post Type |
$post_parent | integer | Post Parent ID |
$original_slug | string | Original slug value |
return | string | Final slug value |
public save_template ( array | object $params, boolean $sanitized = false ) : integer | ||
$params | array | object | An associative array of parameters |
$sanitized | boolean | (optional) Decides wether the params have been sanitized before being passed, will sanitize them if false. |
return | integer | The Template ID |
public save_term ( array $term_data, array $term_meta, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | ||
$term_data | array | All term data to be saved (using wp_insert_term / wp_update_term) |
$term_meta | array | All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $post_meta |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Term ID |
public save_term_meta ( integer $id, array $term_meta = null, boolean $strict = false, array $fields = [] ) : integer | ||
$id | integer | Term ID |
$term_meta | array | All meta to be saved (set value to null to delete) |
$strict | boolean | Whether to delete previously saved meta not in $term_meta |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Id of the term with the meta |
public save_user ( array $user_data, array $user_meta = null, boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : integer | ||
$user_data | array | All user data to be saved (using wp_insert_user / wp_update_user) |
$user_meta | array | (optional) All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $user_meta |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | Returns user id on success |
public save_user_meta ( integer $id, array $user_meta = null, boolean $strict = false, array $fields = [] ) : integer | ||
$id | integer | User ID |
$user_meta | array | (optional) All meta to be saved (set value to null to delete) |
$strict | boolean | (optional) Whether to delete previously saved meta not in $user_meta |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | integer | User ID |
public save_wp_object ( string $object_type, array $data, array $meta = [], boolean $strict = false, boolean $sanitized = false, array $fields = [] ) : boolean | mixed | ||
$object_type | string | Object type: post|taxonomy|user|comment|setting |
$data | array | All post data to be saved |
$meta | array | (optional) Associative array of meta keys and values |
$strict | boolean | (optional) Decides whether the previous saved meta should be deleted or not |
$sanitized | boolean | (optional) Will unsanitize the data, should be passed if the data is sanitized before sending. |
$fields | array | (optional) The array of fields and their options, for further processing with |
return | boolean | mixed |