Overview

Classes

  • Papi_Admin
  • Papi_Admin_Ajax
  • Papi_Admin_Assets
  • Papi_Admin_Management_Pages
  • Papi_Admin_Menu
  • Papi_Admin_Meta_Box
  • Papi_Admin_Meta_Box_Tabs
  • Papi_Admin_Option_Handler
  • Papi_Admin_Post_Handler
  • Papi_Admin_View
  • Papi_Attachment_Type
  • Papi_Conditional_Rules
  • Papi_Container
  • Papi_Core_Autoload
  • Papi_Core_Conditional
  • Papi_Core_Conditional_Rule
  • Papi_Core_Data_Handler
  • Papi_Core_Page
  • Papi_Core_Property
  • Papi_Core_Type
  • Papi_Loader
  • Papi_Option_Page
  • Papi_Option_Type
  • Papi_Page_Type
  • Papi_Page_Type_Meta
  • Papi_Porter
  • Papi_Porter_Driver
  • Papi_Porter_Driver_Core
  • Papi_Post_Page
  • Papi_Property
  • Papi_Property_Bool
  • Papi_Property_Checkbox
  • Papi_Property_Color
  • Papi_Property_Datetime
  • Papi_Property_Divider
  • Papi_Property_Dropdown
  • Papi_Property_Editor
  • Papi_Property_Email
  • Papi_Property_File
  • Papi_Property_Flexible
  • Papi_Property_Gallery
  • Papi_Property_Hidden
  • Papi_Property_Html
  • Papi_Property_Image
  • Papi_Property_Link
  • Papi_Property_Number
  • Papi_Property_Post
  • Papi_Property_Radio
  • Papi_Property_Reference
  • Papi_Property_Relationship
  • Papi_Property_Repeater
  • Papi_Property_String
  • Papi_Property_Term
  • Papi_Property_Text
  • Papi_Property_Url
  • Papi_Property_User

Functions

  • current_page
  • papi
  • papi_action_delete_value
  • papi_action_include
  • papi_append_post_type_query
  • papi_body_class
  • papi_cache_delete
  • papi_cache_get
  • papi_cache_key
  • papi_cache_set
  • papi_camel_case
  • papi_cast_string_value
  • papi_convert_to_string
  • papi_current_user_is_allowed
  • papi_dashify
  • papi_delete_field
  • papi_delete_option
  • papi_delete_property_meta_value
  • papi_display_page_type
  • papi_doing_ajax
  • papi_esc_html
  • papi_f
  • papi_field
  • papi_field_shortcode
  • papi_field_value
  • papi_fields
  • papi_filter_conditional_rule_allowed
  • papi_filter_core_load_one_type_on
  • papi_filter_format_value
  • papi_filter_load_value
  • papi_filter_settings_directories
  • papi_filter_settings_only_page_type
  • papi_filter_settings_page_type_column_title
  • papi_filter_settings_show_page_type
  • papi_filter_settings_show_standard_page_type
  • papi_filter_settings_show_standard_page_type_in_filter
  • papi_filter_settings_sort_order
  • papi_filter_settings_standard_page_description
  • papi_filter_settings_standard_page_name
  • papi_filter_settings_standard_page_thumbnail
  • papi_filter_update_value
  • papi_from_property_array_slugs
  • papi_get_all_files_in_directory
  • papi_get_all_page_type_files
  • papi_get_all_page_types
  • papi_get_box_property
  • papi_get_class_name
  • papi_get_field
  • papi_get_file_path
  • papi_get_number_of_pages
  • papi_get_only_objects
  • papi_get_option
  • papi_get_options_and_properties
  • papi_get_or_post
  • papi_get_page
  • papi_get_page_new_url
  • papi_get_page_query_strings
  • papi_get_page_type
  • papi_get_page_type_base_path
  • papi_get_page_type_by_id
  • papi_get_page_type_by_post_id
  • papi_get_page_type_id
  • papi_get_page_type_key
  • papi_get_page_type_meta_value
  • papi_get_page_type_name
  • papi_get_page_type_template
  • papi_get_parent_post_id
  • papi_get_post_id
  • papi_get_post_type
  • papi_get_post_type_label
  • papi_get_post_types
  • papi_get_property_class_name
  • papi_get_property_meta_value
  • papi_get_property_options
  • papi_get_property_type
  • papi_get_property_type_key
  • papi_get_property_type_key_f
  • papi_get_qs
  • papi_get_sanitized_post
  • papi_get_slugs
  • papi_get_tab_options
  • papi_html_name
  • papi_html_tag
  • papi_include_template
  • papi_is_empty
  • papi_is_json
  • papi_is_method
  • papi_is_option_page
  • papi_is_option_type
  • papi_is_page_type
  • papi_is_property
  • papi_is_property_type_key
  • papi_is_rule
  • papi_management_page_type_render_box
  • papi_maybe_convert_to_array
  • papi_maybe_convert_to_object
  • papi_maybe_get_callable_value
  • papi_maybe_json_decode
  • papi_maybe_json_encode
  • papi_nl2br
  • papi_option_shortcode
  • papi_option_type_exists
  • papi_page_type_exists
  • papi_populate_properties
  • papi_property
  • papi_remove_papi
  • papi_remove_trailing_quotes
  • papi_render_html_tag
  • papi_render_properties
  • papi_render_property
  • papi_require_text
  • papi_required_html
  • papi_rule
  • papi_santize_data
  • papi_set_page_type_id
  • papi_setup_tabs
  • papi_slugify
  • papi_sort_order
  • papi_tab
  • papi_template
  • papi_template_include
  • papi_to_array
  • papi_to_property_array_slugs
  • papi_translate_keys
  • papi_underscorify
  • papi_update_field
  • papi_update_option
  • papi_update_property_meta_value
  • papi_with
  • papify
  • the_papi_field
  • the_papi_option
  • the_papi_page_type_name
  • Overview
  • Class
  1: <?php
  2: 
  3: /**
  4:  * User property that handle relationship between
  5:  * users and posts.
  6:  */
  7: class Papi_Property_User extends Papi_Property_Dropdown {
  8: 
  9:     /**
 10:      * The convert type.
 11:      *
 12:      * @var string
 13:      */
 14:     public $convert_type = 'int';
 15: 
 16:     /**
 17:      * Format the value of the property before it's returned
 18:      * to WordPress admin or the site.
 19:      *
 20:      * @param  mixed  $value
 21:      * @param  string $slug
 22:      * @param  int    $post_id
 23:      *
 24:      * @return array
 25:      */
 26:     public function format_value( $value, $slug, $post_id ) {
 27:         if ( is_object( $value ) && isset( $value->ID ) ) {
 28:             $value = $value->ID;
 29:         }
 30: 
 31:         if ( is_numeric( $value ) ) {
 32:             return new WP_User( $value );
 33:         }
 34: 
 35:         return $value;
 36:     }
 37: 
 38:     /**
 39:      * Get default settings.
 40:      *
 41:      * @return array
 42:      */
 43:     public function get_default_settings() {
 44:         return [
 45:             'capabilities' => [],
 46:             'placeholder'  => '',
 47:             'select2'      => true
 48:         ];
 49:     }
 50: 
 51:     /**
 52:      * Get value from database.
 53:      *
 54:      * @return int
 55:      */
 56:     public function get_value() {
 57:         $user = parent::get_value();
 58: 
 59:         if ( is_object( $user ) && isset( $user->ID ) ) {
 60:             return $user->ID;
 61:         }
 62: 
 63:         return 0;
 64:     }
 65: 
 66:     /**
 67:      * Get users as dropdown items.
 68:      *
 69:      * @return array
 70:      */
 71:     public function get_items() {
 72:         $capabilities = papi_to_array( $this->get_setting( 'capabilities' ) );
 73:         $users        = get_users();
 74:         $items        = [];
 75: 
 76:         foreach ( $users as $user ) {
 77:             $allcaps = $user->allcaps;
 78: 
 79:             if ( count( array_diff( $capabilities, array_keys( $allcaps ) ) ) === 0 ) {
 80:                 $items[$user->display_name] = $user->ID;
 81:             }
 82:         }
 83: 
 84:         return $items;
 85:     }
 86: 
 87:     /**
 88:      * Import value to the property.
 89:      *
 90:      * @param  mixed  $value
 91:      * @param  string $slug
 92:      * @param  int    $post_id
 93:      *
 94:      * @return int|null
 95:      */
 96:     public function import_value( $value, $slug, $post_id ) {
 97:         if ( $value instanceof WP_User ) {
 98:             $value = $value->ID;
 99:         }
100: 
101:         if ( is_numeric( $value ) ) {
102:             return (int) $value;
103:         }
104: 
105:         return $this->default_value;
106:     }
107: 
108:     /**
109:      * Change value after it's loaded from the database.
110:      *
111:      * @param  mixed  $value
112:      * @param  string $slug
113:      * @param  int    $post_id
114:      *
115:      * @return int
116:      */
117:     public function load_value( $value, $slug, $post_id ) {
118:         return (int) $value;
119:     }
120: 
121:     /**
122:      * Update value before it's saved to the database.
123:      *
124:      * @param mixed  $value
125:      * @param string $slug
126:      * @param int    $post_id
127:      *
128:      * @return int
129:      */
130:     public function update_value( $value, $slug, $post_id ) {
131:         if ( $value instanceof WP_User ) {
132:             $value = $value->ID;
133:         }
134: 
135:         return (int) $value;
136:     }
137: }
138: 
API documentation generated by ApiGen