Class WC_Customer_Data_Store

WC Customer Data Store.

WC_Data_Store_WP

Extended by

WC_Customer_Data_Store implements WC_Customer_Data_Store_Interface, WC_Object_Data_Store_Interface

Package: WooCommerce\DataStores
Version: 3.0.0
Located at data-stores/class-wc-customer-data-store.php

Methods summary

`protected boolean`	# `exclude_internal_meta_keys( object $meta )` Callback to remove unwanted meta data. Callback to remove unwanted meta data. Parameters `$meta` Meta object. Returns boolean Overrides `WC_Data_Store_WP::exclude_internal_meta_keys`
`public`	# `create( WC_Customer & $customer )` Method to create a new customer in the database. Method to create a new customer in the database. Parameters `$customer` Customer object. Throws `WC_Data_Exception` If unable to create new customer. Since 3.0.0 Implementation of `WC_Object_Data_Store_Interface::create()`
`public`	# `read( WC_Customer & $customer )` Method to read a customer object. Method to read a customer object. Parameters `$customer` Customer object. Throws Exception If invalid customer. Since 3.0.0 Implementation of `WC_Object_Data_Store_Interface::read()`
`public`	# `update( WC_Customer & $customer )` Updates a customer in the database. Updates a customer in the database. Parameters `$customer` Customer object. Since 3.0.0 Implementation of `WC_Object_Data_Store_Interface::update()`
`public boolean`	# `delete( WC_Customer & $customer, array $args = array() )` Deletes a customer from the database. Deletes a customer from the database. Parameters `$customer` Customer object. `$args` Array of args to pass to the delete method. Returns boolean result Since 3.0.0 Implementation of `WC_Object_Data_Store_Interface::delete()`
`public WC_Order\|false`	# `get_last_order( WC_Customer & $customer )` Gets the customers last order. Gets the customers last order. Parameters `$customer` Customer object. Returns `WC_Order`\|false Since 3.0.0 Implementation of `WC_Customer_Data_Store_Interface::get_last_order()`
`public integer`	# `get_order_count( WC_Customer & $customer )` Return the number of orders this customer has. Return the number of orders this customer has. Parameters `$customer` Customer object. Returns integer Since 3.0.0 Implementation of `WC_Customer_Data_Store_Interface::get_order_count()`
`public float`	# `get_total_spent( WC_Customer & $customer )` Return how much money this customer has spent. Return how much money this customer has spent. Parameters `$customer` Customer object. Returns float Since 3.0.0 Implementation of `WC_Customer_Data_Store_Interface::get_total_spent()`
`public array`	# `search_customers( string $term, integer\|string $limit = '' )` Search customers and return customer IDs. Search customers and return customer IDs. Parameters `$term` Search term. `$limit` Limit search results. Returns array Since 3.0.7

Methods inherited from WC_Data_Store_WP

add_meta(), delete_from_lookup_table(), delete_meta(), get_data_for_lookup_table(), get_db_info(), get_internal_meta_keys(), get_primary_key_for_lookup_table(), get_props_to_update(), get_search_stopwords(), get_term_ids(), get_valid_search_terms(), get_wp_query_args(), parse_date_for_wp_query(), prefix_key(), read_meta(), update_lookup_table(), update_meta(), update_or_delete_post_meta()

Properties summary

`protected array`	`$internal_meta_keys` Data stored in meta keys, but not considered "meta". Data stored in meta keys, but not considered "meta". Since 3.0.0	# array( 'locale', 'billing_postcode', 'billing_city', 'billing_address_1', 'billing_address_2', 'billing_state', 'billing_country', 'shipping_postcode', 'shipping_city', 'shipping_address_1', 'shipping_address_2', 'shipping_state', 'shipping_country', 'paying_customer', 'last_update', 'first_name', 'last_name', 'display_name', 'show_admin_bar_front', 'use_ssl', 'admin_color', 'rich_editing', 'comment_shortcuts', 'dismissed_wp_pointers', 'show_welcome_panel', 'session_tokens', 'nickname', 'description', 'billing_first_name', 'billing_last_name', 'billing_company', 'billing_phone', 'billing_email', 'shipping_first_name', 'shipping_last_name', 'shipping_company', 'wptests_capabilities', 'wptests_user_level', 'syntax_highlighting', '_order_count', '_money_spent', '_woocommerce_tracks_anon_id', )
`protected string`	`$meta_type` Internal meta type used to store user data. Internal meta type used to store user data.	# `'user'`

Properties inherited from WC_Data_Store_WP

$must_exist_meta_keys, $object_id_field_for_meta