PHP Class PodsMeta, pods

Show file Open project: pods-framework/pods Class Usage Examples

Public Properties

Property Type Description
$advanced_content_types array
$comment array
$groups array
$instance PodsMeta
$media array
$object_identifier integer
$old_post_status string
$post_types array
$queue array
$settings array
$taxonomies array
$user array

Public Methods

Method Description
__construct ( ) : PodsMeta
add_class_submittable ( ) Called by 'post_edit_form_tag' action to include the classes in the
tag
add_comment_meta ( ) : mixed
add_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', boolean $unique = false ) : boolean | integer | null
add_option ( ) : mixed
add_post_meta ( ) : mixed
add_term_meta ( ) : mixed
add_user_meta ( ) : mixed
cache_pods ( ) Go back through and cache the Pods now that Polylang has loaded
core ( ) : PodsMeta
cpac_meta_keys ( $meta_fields, $storage_model )
cpac_meta_value ( $meta, $id, $obj )
cpac_meta_values ( $meta, $field_type, $field, $type, $id )
cpac_post_types ( $post_types )
delete_comment ( $id )
delete_comment_meta ( ) : mixed
delete_media ( $id )
delete_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', boolean $delete_all = false ) : null
delete_object ( $type, $id, $name = null )
delete_option ( ) : mixed
delete_post ( $id )
delete_post_meta ( ) : mixed
delete_taxonomy ( $id )
delete_term_meta ( ) : mixed
delete_user ( $id )
delete_user_meta ( ) : mixed
enqueue ( )
get_comment_meta ( ) : mixed
get_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', boolean $single = false ) : array | boolean | integer | mixed | null | string | void
get_object ( $object_type, $object_id, string $aux = '' ) : boolean | mixed
get_option ( ) : mixed All *_*_meta filter handler aliases
get_post_meta ( ) : mixed All *_*_meta filter handler aliases
get_term_meta ( ) : mixed
get_user_meta ( ) : mixed
group_add ( string | array $pod, string $label, string | array $fields, string $context = 'normal', string $priority = 'default' ) : mixed | void Add a meta group of fields to add/edit forms
groups_get ( $type, $name, $default_fields = null ) : array
init ( ) : PodsMeta Singleton handling for a basic pods_meta() request
integrations ( )
meta_comment ( $comment, $metabox )
meta_comment_add ( $comment_type, null $comment = null )
meta_comment_new ( $form_fields ) : array
meta_comment_new_logged_in ( $commenter, $user_identity )
meta_media ( $form_fields, $post ) : array
meta_post ( $post, $metabox )
meta_post_add ( $post_type, null $post = null )
meta_taxonomy ( $tag, null $taxonomy = null )
meta_user ( $user_id )
object_get ( $type, $name )
register ( $type, $pod )
register_field ( $pod, $field )
save_comment ( $comment_id )
save_media ( $post, $attachment ) : mixed
save_media_ajax ( )
save_post ( $post_id, $post, $update = null ) : integer
save_post_detect_new ( $new_status, $old_status, $post )
save_taxonomy ( $term_id, $term_taxonomy_id, $taxonomy )
save_user ( $user_id )
split_shared_term ( integer $term_id, integer $new_term_id, integer $term_taxonomy_id, string $taxonomy ) Hook the split_shared_term action and point it to this method
update_comment_meta ( ) : mixed
update_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', string $prev_value = '' ) : boolean | integer | null
update_option ( ) : mixed
update_post_meta ( ) : mixed
update_term_meta ( ) : mixed
update_user_meta ( ) : mixed
validate_comment ( $approved, $commentdata )

Method Details

__construct() public method

Since: 2.0
public __construct ( ) : PodsMeta
return PodsMeta

add_class_submittable() public method

Called by 'post_edit_form_tag' action to include the classes in the tag

add_comment_meta() public method

public add_comment_meta ( ) : mixed
return mixed

add_meta() public method

public add_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', boolean $unique = false ) : boolean | integer | null
$object_type
$_null null
$object_id integer
$meta_key string
$meta_value string
$unique boolean
return boolean | integer | null

add_option() public method

public add_option ( ) : mixed
return mixed

add_post_meta() public method

public add_post_meta ( ) : mixed
return mixed

add_term_meta() public method

public add_term_meta ( ) : mixed
return mixed

add_user_meta() public method

public add_user_meta ( ) : mixed
return mixed

cache_pods() public method

Go back through and cache the Pods now that Polylang has loaded
public cache_pods ( )

core() public method

public core ( ) : PodsMeta
return PodsMeta

cpac_meta_keys() public method

public cpac_meta_keys ( $meta_fields, $storage_model )

cpac_meta_value() public method

public cpac_meta_value ( $meta, $id, $obj )

cpac_meta_values() public method

public cpac_meta_values ( $meta, $field_type, $field, $type, $id )

cpac_post_types() public method

public cpac_post_types ( $post_types )

delete_comment() public method

public delete_comment ( $id )

delete_comment_meta() public method

public delete_comment_meta ( ) : mixed
return mixed

delete_media() public method

public delete_media ( $id )

delete_meta() public method

public delete_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', boolean $delete_all = false ) : null
$object_type
$_null null
$object_id integer
$meta_key string
$meta_value string
$delete_all boolean
return null

delete_object() public method

public delete_object ( $type, $id, $name = null )

delete_option() public method

public delete_option ( ) : mixed
return mixed

delete_post() public method

public delete_post ( $id )

delete_post_meta() public method

public delete_post_meta ( ) : mixed
return mixed

delete_taxonomy() public method

public delete_taxonomy ( $id )

delete_term_meta() public method

public delete_term_meta ( ) : mixed
return mixed

delete_user() public method

public delete_user ( $id )

delete_user_meta() public method

public delete_user_meta ( ) : mixed
return mixed

enqueue() public static method

public static enqueue ( )

get_comment_meta() public method

public get_comment_meta ( ) : mixed
return mixed

get_meta() public method

public get_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', boolean $single = false ) : array | boolean | integer | mixed | null | string | void
$object_type
$_null null
$object_id integer
$meta_key string
$single boolean
return array | boolean | integer | mixed | null | string | void

get_object() public method

public get_object ( $object_type, $object_id, string $aux = '' ) : boolean | mixed
$object_type
$object_id
$aux string
return boolean | mixed

get_option() public method

All *_*_meta filter handler aliases
public get_option ( ) : mixed
return mixed

get_post_meta() public method

All *_*_meta filter handler aliases
public get_post_meta ( ) : mixed
return mixed

get_term_meta() public method

public get_term_meta ( ) : mixed
return mixed

get_user_meta() public method

public get_user_meta ( ) : mixed
return mixed

group_add() public method

Add a meta group of fields to add/edit forms
Since: 2.0
public group_add ( string | array $pod, string $label, string | array $fields, string $context = 'normal', string $priority = 'default' ) : mixed | void
$pod string | array The pod or type of element to attach the group to.
$label string Title of the edit screen section, visible to user.
$fields string | array Either a comma separated list of text fields or an associative array containing field infomration.
$context string (optional) The part of the page where the edit screen section should be shown ('normal', 'advanced', or 'side').
$priority string (optional) The priority within the context where the boxes should show ('high', 'core', 'default' or 'low').
return mixed | void

groups_get() public method

public groups_get ( $type, $name, $default_fields = null ) : array
$type
$name
$default_fields
return array

init() public static method

Singleton handling for a basic pods_meta() request
Since: 2.3.5
public static init ( ) : PodsMeta
return PodsMeta

integrations() public method

public integrations ( )

meta_comment() public method

public meta_comment ( $comment, $metabox )
$comment
$metabox

meta_comment_add() public method

public meta_comment_add ( $comment_type, null $comment = null )
$comment_type
$comment null

meta_comment_new() public method

public meta_comment_new ( $form_fields ) : array
$form_fields
return array

meta_comment_new_logged_in() public method

public meta_comment_new_logged_in ( $commenter, $user_identity )
$commenter
$user_identity

meta_media() public method

public meta_media ( $form_fields, $post ) : array
$form_fields
$post
return array

meta_post() public method

public meta_post ( $post, $metabox )
$post
$metabox

meta_post_add() public method

public meta_post_add ( $post_type, null $post = null )
$post_type
$post null

meta_taxonomy() public method

public meta_taxonomy ( $tag, null $taxonomy = null )
$tag
$taxonomy null

meta_user() public method

public meta_user ( $user_id )
$user_id

object_get() public method

public object_get ( $type, $name )

register() public method

public register ( $type, $pod )

register_field() public method

public register_field ( $pod, $field )

save_comment() public method

public save_comment ( $comment_id )
$comment_id

save_media() public method

public save_media ( $post, $attachment ) : mixed
$post
$attachment
return mixed

save_media_ajax() public method

public save_media_ajax ( )

save_post() public method

public save_post ( $post_id, $post, $update = null ) : integer
$post_id
$post
$update
return integer Post ID

save_post_detect_new() public method

public save_post_detect_new ( $new_status, $old_status, $post )
$new_status
$old_status
$post

save_taxonomy() public method

public save_taxonomy ( $term_id, $term_taxonomy_id, $taxonomy )
$term_id
$term_taxonomy_id
$taxonomy

save_user() public method

public save_user ( $user_id )
$user_id

split_shared_term() public static method

Fires after a previously shared taxonomy term is split into two separate terms.
public static split_shared_term ( integer $term_id, integer $new_term_id, integer $term_taxonomy_id, string $taxonomy )
$term_id integer ID of the formerly shared term.
$new_term_id integer ID of the new term created for the $term_taxonomy_id.
$term_taxonomy_id integer ID for the term_taxonomy row affected by the split.
$taxonomy string Taxonomy for the split term.

update_comment_meta() public method

public update_comment_meta ( ) : mixed
return mixed

update_meta() public method

public update_meta ( $object_type, null $_null = null, integer $object_id, string $meta_key = '', string $meta_value = '', string $prev_value = '' ) : boolean | integer | null
$object_type
$_null null
$object_id integer
$meta_key string
$meta_value string
$prev_value string
return boolean | integer | null

update_option() public method

public update_option ( ) : mixed
return mixed

update_post_meta() public method

public update_post_meta ( ) : mixed
return mixed

update_term_meta() public method

public update_term_meta ( ) : mixed
return mixed

update_user_meta() public method

public update_user_meta ( ) : mixed
return mixed

validate_comment() public method

public validate_comment ( $approved, $commentdata )
$approved
$commentdata

Property Details

$advanced_content_types public static property

public static array $advanced_content_types
return array

$comment public static property

public static array $comment
return array

$groups public static property

public static array $groups
return array

$instance static public property

static public PodsMeta $instance
return PodsMeta

$media public static property

public static array $media
return array

$object_identifier public static property

public static int $object_identifier
return integer

$old_post_status public static property

public static string $old_post_status
return string

$post_types public static property

public static array $post_types
return array

$queue public static property

public static array $queue
return array

$settings public static property

public static array $settings
return array

$taxonomies public static property

public static array $taxonomies
return array

$user public static property

public static array $user
return array