WC_Customer_Data_Store{} │ WC 1.0
WC Customer Data Store.
Hooks from the class
Usage
$WC_Customer_Data_Store = new WC_Customer_Data_Store(); // use class methods
Methods
- public create( &$customer )
- public delete( &$customer, $args = array() )
- protected exclude_internal_meta_keys( $meta )
- public get_last_order( &$customer )
- public get_order_count( &$customer )
- public get_total_spent( &$customer )
- public get_user_ids_for_billing_email( $emails )
- private is_cot_in_use()
- public read( &$customer )
- public search_customers( $term, $limit = '' )
- public update( &$customer )
- private update_user_meta( $customer )
WC_Customer_Data_Store{} WC Customer Data Store{} code WC 9.4.2
class WC_Customer_Data_Store extends WC_Data_Store_WP implements WC_Customer_Data_Store_Interface, WC_Object_Data_Store_Interface { /** * Data stored in meta keys, but not considered "meta". * * @since 3.0.0 * @var array */ protected $internal_meta_keys = 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', 'shipping_phone', 'wptests_capabilities', 'wptests_user_level', 'syntax_highlighting', '_order_count', '_money_spent', '_last_order', '_woocommerce_tracks_anon_id', ); /** * Internal meta type used to store user data. * * @var string */ protected $meta_type = 'user'; /** * Callback to remove unwanted meta data. * * @param object $meta Meta object. * @return bool */ protected function exclude_internal_meta_keys( $meta ) { global $wpdb; $table_prefix = $wpdb->prefix ? $wpdb->prefix : 'wp_'; return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== strpos( $meta->meta_key, '_woocommerce_persistent_cart' ) && 0 !== strpos( $meta->meta_key, 'closedpostboxes_' ) && 0 !== strpos( $meta->meta_key, 'metaboxhidden_' ) && 0 !== strpos( $meta->meta_key, 'manageedit-' ) && ! strstr( $meta->meta_key, $table_prefix ) && 0 !== stripos( $meta->meta_key, 'wp_' ); } /** * Method to create a new customer in the database. * * @since 3.0.0 * * @param WC_Customer $customer Customer object. * * @throws WC_Data_Exception If unable to create new customer. */ public function create( &$customer ) { $id = wc_create_new_customer( $customer->get_email(), $customer->get_username(), $customer->get_password() ); if ( is_wp_error( $id ) ) { throw new WC_Data_Exception( $id->get_error_code(), $id->get_error_message() ); } $customer->set_id( $id ); $this->update_user_meta( $customer ); // Prevent wp_update_user calls in the same request and customer trigger the 'Notice of Password Changed' email. $customer->set_password( '' ); wp_update_user( apply_filters( 'woocommerce_update_customer_args', array( 'ID' => $customer->get_id(), 'role' => $customer->get_role(), 'display_name' => $customer->get_display_name(), ), $customer ) ); $wp_user = new WP_User( $customer->get_id() ); $customer->set_date_created( $wp_user->user_registered ); $customer->set_date_modified( get_user_meta( $customer->get_id(), 'last_update', true ) ); $customer->save_meta_data(); $customer->apply_changes(); do_action( 'woocommerce_new_customer', $customer->get_id(), $customer ); } /** * Method to read a customer object. * * @since 3.0.0 * @param WC_Customer $customer Customer object. * @throws Exception If invalid customer. */ public function read( &$customer ) { $user_object = $customer->get_id() ? get_user_by( 'id', $customer->get_id() ) : false; // User object is required. if ( ! $user_object || empty( $user_object->ID ) ) { throw new Exception( __( 'Invalid customer.', 'woocommerce' ) ); } $customer_id = $customer->get_id(); // Load meta but exclude deprecated props and parent keys. $user_meta = array_diff_key( array_change_key_case( array_map( 'wc_flatten_meta_callback', get_user_meta( $customer_id ) ) ), array_flip( array( 'country', 'state', 'postcode', 'city', 'address', 'address_2', 'default', 'location' ) ), array_change_key_case( (array) $user_object->data ) ); $customer->set_props( $user_meta ); $customer->set_props( array( 'is_paying_customer' => get_user_meta( $customer_id, 'paying_customer', true ), 'email' => $user_object->user_email, 'username' => $user_object->user_login, 'display_name' => $user_object->display_name, 'date_created' => $user_object->user_registered, // Mysql string in local format. 'date_modified' => get_user_meta( $customer_id, 'last_update', true ), 'role' => ! empty( $user_object->roles[0] ) ? $user_object->roles[0] : 'customer', ) ); $customer->read_meta_data(); $customer->set_object_read( true ); do_action( 'woocommerce_customer_loaded', $customer ); } /** * Updates a customer in the database. * * @since 3.0.0 * @param WC_Customer $customer Customer object. */ public function update( &$customer ) { wp_update_user( apply_filters( 'woocommerce_update_customer_args', array( 'ID' => $customer->get_id(), 'user_email' => $customer->get_email(), 'display_name' => $customer->get_display_name(), ), $customer ) ); // Only update password if a new one was set with set_password. if ( $customer->get_password() ) { wp_update_user( array( 'ID' => $customer->get_id(), 'user_pass' => $customer->get_password(), ) ); $customer->set_password( '' ); } $this->update_user_meta( $customer ); $customer->set_date_modified( get_user_meta( $customer->get_id(), 'last_update', true ) ); $customer->save_meta_data(); $customer->apply_changes(); do_action( 'woocommerce_update_customer', $customer->get_id(), $customer ); } /** * Deletes a customer from the database. * * @since 3.0.0 * @param WC_Customer $customer Customer object. * @param array $args Array of args to pass to the delete method. */ public function delete( &$customer, $args = array() ) { if ( ! $customer->get_id() ) { return; } $args = wp_parse_args( $args, array( 'reassign' => 0, ) ); $id = $customer->get_id(); wp_delete_user( $id, $args['reassign'] ); do_action( 'woocommerce_delete_customer', $id ); } /** * Helper method that updates all the meta for a customer. Used for update & create. * * @since 3.0.0 * @param WC_Customer $customer Customer object. */ private function update_user_meta( $customer ) { $updated_props = array(); $changed_props = $customer->get_changes(); $meta_key_to_props = array( 'paying_customer' => 'is_paying_customer', 'first_name' => 'first_name', 'last_name' => 'last_name', ); foreach ( $meta_key_to_props as $meta_key => $prop ) { if ( ! array_key_exists( $prop, $changed_props ) ) { continue; } if ( update_user_meta( $customer->get_id(), $meta_key, $customer->{"get_$prop"}( 'edit' ) ) ) { $updated_props[] = $prop; } } $billing_address_props = array( 'billing_first_name' => 'billing_first_name', 'billing_last_name' => 'billing_last_name', 'billing_company' => 'billing_company', 'billing_address_1' => 'billing_address_1', 'billing_address_2' => 'billing_address_2', 'billing_city' => 'billing_city', 'billing_state' => 'billing_state', 'billing_postcode' => 'billing_postcode', 'billing_country' => 'billing_country', 'billing_email' => 'billing_email', 'billing_phone' => 'billing_phone', ); foreach ( $billing_address_props as $meta_key => $prop ) { $prop_key = substr( $prop, 8 ); if ( ! isset( $changed_props['billing'] ) || ! array_key_exists( $prop_key, $changed_props['billing'] ) ) { continue; } if ( update_user_meta( $customer->get_id(), $meta_key, $customer->{"get_$prop"}( 'edit' ) ) ) { $updated_props[] = $prop; } } $shipping_address_props = array( 'shipping_first_name' => 'shipping_first_name', 'shipping_last_name' => 'shipping_last_name', 'shipping_company' => 'shipping_company', 'shipping_address_1' => 'shipping_address_1', 'shipping_address_2' => 'shipping_address_2', 'shipping_city' => 'shipping_city', 'shipping_state' => 'shipping_state', 'shipping_postcode' => 'shipping_postcode', 'shipping_country' => 'shipping_country', 'shipping_phone' => 'shipping_phone', ); foreach ( $shipping_address_props as $meta_key => $prop ) { $prop_key = substr( $prop, 9 ); if ( ! isset( $changed_props['shipping'] ) || ! array_key_exists( $prop_key, $changed_props['shipping'] ) ) { continue; } if ( update_user_meta( $customer->get_id(), $meta_key, $customer->{"get_$prop"}( 'edit' ) ) ) { $updated_props[] = $prop; } } do_action( 'woocommerce_customer_object_updated_props', $customer, $updated_props ); } /** * Check if the usage of the custom orders table is enabled. * * @return bool */ private function is_cot_in_use(): bool { return wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled(); } /** * Gets the customers last order. * * @since 3.0.0 * @param WC_Customer $customer Customer object. * @return WC_Order|false */ public function get_last_order( &$customer ) { // Try to fetch the last order placed by this customer. $last_order_id = Users::get_site_user_meta( $customer->get_id(), 'wc_last_order', true ); $last_customer_order = false; if ( ! empty( $last_order_id ) ) { $last_customer_order = wc_get_order( $last_order_id ); } // "Unset" the last order ID if the order is associated with another customer. Unsetting is done by making it an // empty string, for compatibility with the declared types of the following filter hook. if ( ! $last_customer_order instanceof WC_Order || intval( $last_customer_order->get_customer_id() ) !== intval( $customer->get_id() ) ) { $last_order_id = ''; } /** * Filters the id of the last order from a given customer. * * @since 4.9.1 * * @param string $last_order_id The last order id as retrieved from the database. * @param WC_Customer $customer The customer whose last order id is being retrieved. * * @return string The actual last order id to use. */ $last_order_id = apply_filters( 'woocommerce_customer_get_last_order', $last_order_id, $customer ); //phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment if ( '' === $last_order_id ) { global $wpdb; $order_statuses_sql = "( '" . implode( "','", array_map( 'esc_sql', array_keys( wc_get_order_statuses() ) ) ) . "' )"; //phpcs:disable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared if ( $this->is_cot_in_use() ) { $sql = $wpdb->prepare( 'SELECT id FROM ' . OrdersTableDataStore::get_orders_table_name() . " WHERE customer_id = %d AND status in $order_statuses_sql ORDER BY id DESC LIMIT 1", $customer->get_id() ); $last_order_id = $wpdb->get_var( $sql ); } else { $last_order_id = $wpdb->get_var( "SELECT posts.ID FROM $wpdb->posts AS posts LEFT JOIN {$wpdb->postmeta} AS meta on posts.ID = meta.post_id WHERE meta.meta_key = '_customer_user' AND meta.meta_value = '" . esc_sql( $customer->get_id() ) . "' AND posts.post_type = 'shop_order' AND posts.post_status IN $order_statuses_sql ORDER BY posts.ID DESC LIMIT 1" ); } //phpcs:enable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared Users::update_site_user_meta( $customer->get_id(), 'wc_last_order', $last_order_id ); } if ( ! $last_order_id ) { return false; } return wc_get_order( absint( $last_order_id ) ); } /** * Return the number of orders this customer has. * * @since 3.0.0 * @param WC_Customer $customer Customer object. * @return integer */ public function get_order_count( &$customer ) { $count = apply_filters( 'woocommerce_customer_get_order_count', Users::get_site_user_meta( $customer->get_id(), 'wc_order_count', true ), $customer ); $order_statuses_sql = "( '" . implode( "','", array_map( 'esc_sql', array_keys( wc_get_order_statuses() ) ) ) . "' )"; if ( '' === $count ) { global $wpdb; //phpcs:disable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared if ( $this->is_cot_in_use() ) { $sql = $wpdb->prepare( 'SELECT COUNT(id) FROM ' . OrdersTableDataStore::get_orders_table_name() . " WHERE customer_id = %d AND status in $order_statuses_sql", $customer->get_id() ); $count = $wpdb->get_var( $sql ); } else { $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts as posts LEFT JOIN {$wpdb->postmeta} AS meta ON posts.ID = meta.post_id WHERE meta.meta_key = '_customer_user' AND posts.post_type = 'shop_order' AND posts.post_status IN $order_statuses_sql AND meta_value = '" . esc_sql( $customer->get_id() ) . "'" ); } //phpcs:enable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared Users::update_site_user_meta( $customer->get_id(), 'wc_order_count', $count ); } return absint( $count ); } /** * Return how much money this customer has spent. * * @since 3.0.0 * @param WC_Customer $customer Customer object. * @return float */ public function get_total_spent( &$customer ) { $spent = apply_filters( 'woocommerce_customer_get_total_spent', Users::get_site_user_meta( $customer->get_id(), 'wc_money_spent', true ), $customer ); if ( '' === $spent ) { global $wpdb; $statuses = array_map( 'esc_sql', wc_get_is_paid_statuses() ); $statuses_sql = "( 'wc-" . implode( "','wc-", $statuses ) . "' )"; //phpcs:disable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared if ( $this->is_cot_in_use() ) { $sql = $wpdb->prepare( 'SELECT SUM(total_amount) FROM ' . OrdersTableDataStore::get_orders_table_name() . " WHERE customer_id = %d AND status in $statuses_sql", $customer->get_id() ); } else { $sql = "SELECT SUM(meta2.meta_value) FROM $wpdb->posts as posts LEFT JOIN {$wpdb->postmeta} AS meta ON posts.ID = meta.post_id LEFT JOIN {$wpdb->postmeta} AS meta2 ON posts.ID = meta2.post_id WHERE meta.meta_key = '_customer_user' AND meta.meta_value = '" . esc_sql( $customer->get_id() ) . "' AND posts.post_type = 'shop_order' AND posts.post_status IN $statuses_sql AND meta2.meta_key = '_order_total'"; } //phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment /** * Filters the SQL query used to get the combined total of all the orders from a given customer. * * @param string The SQL query to use. * @param WC_Customer The customer to get the total spent for. * @return string The actual SQL query to use. */ $sql = apply_filters( 'woocommerce_customer_get_total_spent_query', $sql, $customer ); //phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment $spent = $wpdb->get_var( $sql ); //phpcs:enable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared if ( ! $spent ) { $spent = 0; } Users::update_site_user_meta( $customer->get_id(), 'wc_money_spent', $spent ); } return wc_format_decimal( $spent, 2 ); } /** * Search customers and return customer IDs. * * @param string $term Search term. * @param int|string $limit Limit search results. * @since 3.0.7 * * @return array */ public function search_customers( $term, $limit = '' ) { $results = apply_filters( 'woocommerce_customer_pre_search_customers', false, $term, $limit ); if ( is_array( $results ) ) { return $results; } $query = new WP_User_Query( apply_filters( 'woocommerce_customer_search_customers', array( 'search' => '*' . esc_attr( $term ) . '*', 'search_columns' => array( 'user_login', 'user_url', 'user_email', 'user_nicename', 'display_name' ), 'fields' => 'ID', 'number' => $limit, ), $term, $limit, 'main_query' ) ); $query2 = new WP_User_Query( apply_filters( 'woocommerce_customer_search_customers', array( 'fields' => 'ID', 'number' => $limit, 'meta_query' => array( 'relation' => 'OR', array( 'key' => 'first_name', 'value' => $term, 'compare' => 'LIKE', ), array( 'key' => 'last_name', 'value' => $term, 'compare' => 'LIKE', ), ), ), $term, $limit, 'meta_query' ) ); $results = wp_parse_id_list( array_merge( (array) $query->get_results(), (array) $query2->get_results() ) ); if ( $limit && count( $results ) > $limit ) { $results = array_slice( $results, 0, $limit ); } return $results; } /** * Get all user ids who have `billing_email` set to any of the email passed in array. * * @param array $emails List of emails to check against. * * @return array */ public function get_user_ids_for_billing_email( $emails ) { $emails = array_unique( array_map( 'strtolower', array_map( 'sanitize_email', $emails ) ) ); $users_query = new WP_User_Query( array( 'fields' => 'ID', 'meta_query' => array( array( 'key' => 'billing_email', 'value' => $emails, 'compare' => 'IN', ), ), ) ); return array_unique( $users_query->get_results() ); } }