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:  * Term property that handle relationship between
  5:  * terms and posts.
  6:  */
  7: class Papi_Property_Term extends Papi_Property {
  8: 
  9:     /**
 10:      * The convert type.
 11:      *
 12:      * @var string
 13:      */
 14:     public $convert_type = 'object';
 15: 
 16:     /**
 17:      * Get default settings.
 18:      *
 19:      * @return array
 20:      */
 21:     public function get_default_settings() {
 22:         return [
 23:             'taxonomy'      => '',
 24:             'select2'       => true,
 25:             'query'         => []
 26:         ];
 27:     }
 28: 
 29:     /**
 30:      * Get terms.
 31:      *
 32:      * @param  stdClass $settings
 33:      *
 34:      * @return array
 35:      */
 36:     protected function get_terms( $settings ) {
 37:         // Prepare arguments for get_terms.
 38:         $args = array_merge( $settings->query, [
 39:             'fields' => 'id=>name'
 40:         ] );
 41: 
 42:         return get_terms( $settings->taxonomy, $args );
 43:     }
 44: 
 45:     /**
 46:      * Render property html.
 47:      */
 48:     public function html() {
 49:         $settings   = $this->get_settings();
 50:         $value      = $this->get_value();
 51: 
 52:         if ( is_object( $value ) ) {
 53:             $value = $value->term_id;
 54:         } else {
 55:             $value = 0;
 56:         }
 57: 
 58:         $classes = 'papi-fullwidth';
 59: 
 60:         if ( $settings->select2 ) {
 61:             $classes = ' papi-component-select2';
 62:         }
 63:         ?>
 64:         <div class="papi-property-term">
 65:         <?php if ( empty( $settings->taxonomy ) ): ?>
 66:             <p><?php _e( 'No taxonomy defined for term property', 'papi' ); ?></p>
 67:         <?php else:
 68:             $terms = $this->get_terms( $settings );
 69:         ?>
 70:             <select
 71:                 id="<?php echo $this->html_id(); ?>"
 72:                 name="<?php echo $this->html_name(); ?>"
 73:                 class="<?php echo $classes; ?>"
 74:                 data-allow-clear="true"
 75:                 data-placeholder="<?php echo isset( $settings->placeholder ) ? $settings->placeholder : ''; ?>"
 76:                 data-width="100%">
 77: 
 78:                 <?php if ( isset( $settings->placeholder ) ): ?>
 79:                     <option value=""></option>
 80:                 <?php endif; ?>
 81: 
 82:                 <?php foreach ( $terms as $term_id => $term_name ) : ?>
 83:                     <?php
 84:                     papi_render_html_tag( 'option', [
 85:                         'value'    => $term_id,
 86:                         'selected' => $value === $term_id ? 'selected' : null,
 87:                         $term_name
 88:                     ] );
 89:                     ?>
 90:                 <?php endforeach; ?>
 91: 
 92:             </select>
 93:         <?php endif; ?>
 94:         </div>
 95:         <?php
 96:     }
 97: 
 98:     /**
 99:      * Import value to the property.
100:      *
101:      * @param  mixed  $value
102:      * @param  string $slug
103:      * @param  int    $post_id
104:      *
105:      * @return mixed
106:      */
107:     public function import_value( $value, $slug, $post_id ) {
108:         if ( is_object( $value ) && isset( $value->term_id ) ) {
109:             return $value->term_id;
110:         }
111: 
112:         if ( is_numeric( $value ) ) {
113:             return (int) $value;
114:         }
115: 
116:         return $this->default_value;
117:     }
118: 
119:     /**
120:      * Format the value of the property before it's returned to the application.
121:      *
122:      * @param  mixed  $value
123:      * @param  string $slug
124:      * @param  int    $post_id
125:      *
126:      * @return array
127:      */
128:     public function format_value( $value, $slug, $post_id ) {
129:         if ( is_numeric( $value ) && intval( $value ) !== 0 ) {
130:             $settings = $this->get_settings();
131:             return get_term( $value, $settings->taxonomy );
132:         }
133: 
134:         return $this->default_value;
135:     }
136: }
137: 
API documentation generated by ApiGen