wcpos_request = $request; add_filter( 'woocommerce_rest_prepare_customer', array( $this, 'wcpos_customer_response' ), 10, 3 ); add_filter( 'woocommerce_rest_customer_query', array( $this, 'wcpos_customer_query' ), 10, 2 ); add_filter( 'is_protected_meta', array( $this, 'wcpos_allow_uuid_meta' ), 10, 3 ); /* * Check if the request is for all customers and if the 'posts_per_page' is set to -1. * Optimised query for getting all customer IDs. */ if ( -1 == $request->get_param( 'posts_per_page' ) && null !== $request->get_param( 'fields' ) ) { return $this->wcpos_get_all_posts( $request ); } return $dispatch_result; } /** * Add custom fields to the product schema. */ public function get_item_schema() { $schema = parent::get_item_schema(); // Check and remove email format validation from the billing property. if ( isset( $schema['properties']['billing']['properties']['email']['format'] ) ) { unset( $schema['properties']['billing']['properties']['email']['format'] ); } // Add structured tax_ids property (TaxId[]). $schema['properties']['tax_ids'] = array( 'description' => /* translators: REST API schema field label or error message. */ __( 'Customer tax IDs.', 'woocommerce-pos' ), 'type' => 'array', 'context' => array( 'view', 'edit' ), 'items' => array( 'type' => 'object', 'properties' => array( 'type' => array( 'type' => 'string', 'enum' => Tax_Id_Types::all_types(), 'description' => /* translators: REST API schema field label or error message. */ __( 'Tax ID type.', 'woocommerce-pos' ), ), 'value' => array( 'type' => 'string', 'description' => /* translators: REST API schema field label or error message. */ __( 'Tax ID value.', 'woocommerce-pos' ), ), 'country' => array( 'type' => array( 'string', 'null' ), 'description' => __( 'ISO 3166-1 alpha-2 country code.', 'woocommerce-pos' ), ), 'label' => array( 'type' => array( 'string', 'null' ), 'description' => /* translators: REST API schema field label or error message. */ __( 'Optional human-readable label.', 'woocommerce-pos' ), ), ), ), ); return $schema; } /** * Check if a given request has access to create a customer. * * WC checks promote_users (< 9.9) or create_customers (9.9+). The POS * fallback checks only the version-appropriate capability so it matches * the toggle shown on the Access settings page. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|bool */ public function create_item_permissions_check( $request ) { $permission = parent::create_item_permissions_check( $request ); if ( is_wp_error( $permission ) ) { $customer_create_cap = version_compare( WC()->version, '9.9', '>=' ) ? 'create_customers' : 'promote_users'; if ( current_user_can( $customer_create_cap ) ) { return true; } } return $permission; } /** * Check if a given request has access to update a customer. * * WC checks edit_users. The POS fallback also checks edit_users so the * Access settings page toggle controls this behaviour. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|bool */ public function update_item_permissions_check( $request ) { $permission = parent::update_item_permissions_check( $request ); if ( is_wp_error( $permission ) && current_user_can( 'edit_users' ) ) { return true; } return $permission; } /** * Add extra fields to WP_REST_Controller::get_collection_params(). * - add new fields to the 'orderby' enum list. */ public function get_collection_params() { $params = parent::get_collection_params(); // Check if 'orderby' is set and is an array before modifying it. if ( isset( $params['orderby'] ) && \is_array( $params['orderby']['enum'] ) ) { // Add new fields to the 'orderby' enum list. $new_orderby_options = array( 'first_name', 'last_name', 'email', 'role', 'username', ); foreach ( $new_orderby_options as $option ) { if ( ! \in_array( $option, $params['orderby']['enum'], true ) ) { $params['orderby']['enum'][] = $option; } } } // Add 'roles' filter, this allows us to filter by multiple roles. $params['roles'] = array( 'description' => __( 'Filter customers by roles.', 'woocommerce-pos' ), 'type' => 'array', 'items' => array( 'type' => 'string', ), 'required' => false, ); return $params; } /** * Create a single item. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|WP_REST_Response */ public function create_item( $request ) { $valid_email = $this->wcpos_validate_billing_email( $request ); if ( is_wp_error( $valid_email ) ) { return $valid_email; } /* * Generate a password for the new user. * Add filter for get_option key 'woocommerce_registration_generate_password' to ensure it is set to 'yes'. */ add_filter( 'pre_option_woocommerce_registration_generate_password', function () { return 'yes'; } ); /* * Optionally generate a username from the customer's email address. * Reads the POS 'generate_username' general setting and overrides the * store-level 'woocommerce_registration_generate_username' option so the * POS behaviour is independent of the online-checkout setting. */ $generate_username = wcpos_get_settings( 'general', 'generate_username' ); add_filter( 'pre_option_woocommerce_registration_generate_username', function () use ( $generate_username ) { return $generate_username ? 'yes' : 'no'; } ); // Proceed with the parent method to handle the creation. $response = parent::create_item( $request ); $this->wcpos_persist_tax_ids_from_request( $response, $request ); return $response; } /** * Update a single order. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|WP_REST_Response */ public function update_item( $request ) { $valid_email = $this->wcpos_validate_billing_email( $request ); if ( is_wp_error( $valid_email ) ) { return $valid_email; } // Proceed with the parent method to handle the creation. $response = parent::update_item( $request ); $this->wcpos_persist_tax_ids_from_request( $response, $request ); return $response; } /** * Persist `tax_ids` from a create/update request via Tax_Id_Writer. * * No-op when the request did not include `tax_ids`, the response is an * error, or the resolved user ID is invalid. * * @param mixed $response Response from the parent controller. * @param WP_REST_Request $request Original request. */ protected function wcpos_persist_tax_ids_from_request( $response, WP_REST_Request $request ): void { if ( ! ( $response instanceof WP_REST_Response ) ) { return; } $tax_ids = $request->get_param( 'tax_ids' ); if ( ! \is_array( $tax_ids ) ) { return; } $data = $response->get_data(); $user_id = isset( $data['id'] ) ? (int) $data['id'] : 0; if ( $user_id <= 0 ) { return; } ( new Tax_Id_Writer() )->write_for_user( $user_id, $tax_ids ); // Reflect persisted list in the response. $data['tax_ids'] = ( new Tax_Id_Reader() )->read_for_user( $user_id ); $response->set_data( $data ); } /** * Validate billing email. * NOTE: we have removed the format check to allow empty email addresses. * * @param WP_REST_Request $request The REST request object. * * @return bool|WP_Error */ public function wcpos_validate_billing_email( WP_REST_Request $request ) { // Your custom validation logic for the request data. $billing = $request['billing'] ?? null; $email = \is_array( $billing ) ? ( $billing['email'] ?? null ) : null; if ( ! \is_null( $email ) && '' !== $email && ! is_email( $email ) ) { return new WP_Error( 'rest_invalid_param', // translators: Use default WordPress translation. __( 'Invalid email address.', 'woocommerce-pos' ), array( 'status' => 400 ) ); } return true; } /** * Filter customer data returned from the REST API. * * @param WP_REST_Response $response The response object. * @param WP_User $user_data User object used to create response. * @param WP_REST_Request $request Request object. */ public function wcpos_customer_response( WP_REST_Response $response, WP_User $user_data, WP_REST_Request $request ): WP_REST_Response { $data = $response->get_data(); // Add the uuid to the response. $this->maybe_add_user_uuid( $user_data ); /* * Add the customer meta data to the response * * In the WC REST Customers Controller -> get_formatted_item_data_core function, the customer's * meta_data is only added for administrators. I assume this is for privacy/security reasons? * * Even for administrators, meta data starting with '_' will be filtered out. * We need to add the uuid meta_data to the response for all cashiers and also non-protected meta. * * This means we let of junk meta_data into the response, but at least we don't block data and allow * saving of meta_data. * * @TODO - add filter settings to block/allow meta_data keys */ try { $customer = new WC_Customer( $user_data->ID ); $raw_meta_data = $customer->get_meta_data(); // Monitor meta count. $this->wcpos_monitor_meta_count( $customer, $raw_meta_data ); $filtered_meta_data = array_filter( $raw_meta_data, function ( $meta ) { return ! is_protected_meta( $meta->key, 'user' ); } ); // Convert to WC REST API expected format. $data['meta_data'] = array_map( function ( $meta ) { return array( 'id' => $meta->id, 'key' => $meta->key, 'value' => $meta->value, ); }, array_values( $filtered_meta_data ) ); } catch ( Exception $e ) { Logger::log( 'Error getting customer meta data: ' . $e->getMessage() ); } // Add structured tax_ids list (read fallback across legacy plugin meta keys). $data['tax_ids'] = ( new Tax_Id_Reader() )->read_for_user( $user_data->ID ); // Estimate response size and log if excessive. $this->wcpos_estimate_response_size( $data, $user_data->ID, 'Customer' ); // Set any changes to the response data. $response->set_data( $data ); return $response; } /** * Returns array of all customer ids. * * Note: user queries are a little more complicated than post queries, for example, * multisite would return all users from all sites, not just the current site. * Also, querying by role is not as simple as querying by post type. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|WP_REST_Response */ public function wcpos_get_all_posts( $request ) { global $wpdb; // Start timing execution. $start_time = microtime( true ); $modified_after = $request->get_param( 'modified_after' ); $dates_are_gmt = true; $fields = $request->get_param( 'fields' ); $id_with_modified_date = array( 'id', 'date_modified_gmt' ) === $fields; $args = array( 'fields' => array( 'ID', 'user_registered' ), // Return only the ID and registered date. // 'role__in' => 'all', // @TODO: could be an array of roles, like ['customer', 'cashier']. ); /* * The user query is too complex to do a direct sql query, eg: multisite would return all users from all sites, * not just the current site. Also, querying by role is not as simple as querying by post type. * * For now we get all user ids and all 'last_update' meta values, then combine them into an array of objects. */ try { $user_query = new WP_User_Query( $args ); $users = $user_query->get_results(); $last_updates = array(); if ( $id_with_modified_date ) { $query = " SELECT user_id, meta_value FROM $wpdb->usermeta WHERE meta_key = 'last_update' "; // If modified_after param is set, add the condition to the query. if ( $modified_after ) { $modified_after_timestamp = strtotime( $modified_after ); $query .= $wpdb->prepare( ' AND meta_value > %d', $modified_after_timestamp ); } $last_update_results = $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared conditionally above. // Manually create the associative array of user_id => last_update. foreach ( $last_update_results as $result ) { $last_updates[ $result->user_id ] = is_numeric( $result->meta_value ) ? gmdate( 'Y-m-d\TH:i:s', (int) $result->meta_value ) : null; } } /** * Performance notes: * - Using a generator is faster than array_map when dealing with large datasets. * - If date is in the format 'Y-m-d H:i:s' we just do preg_replace to 'Y-m-d\TH:i:s', * rather than using wc_rest_prepare_date_response * * This resulted in execution time of 10% of the original time. * * If the modified_after param is set, we don't need to loop through the entire user list. * The last_update_results array will only contain the users that have been modified after the given date. * We just need to check they are valid user ids, this sucks, but there could be orphaned last_update meta values. */ $formatted_results = array(); if ( $modified_after ) { foreach ( $users as $user ) { if ( isset( $last_updates[ $user->ID ] ) ) { $user_info = array( 'id' => (int) $user->ID ); if ( $id_with_modified_date ) { $user_info['date_modified_gmt'] = $last_updates[ $user->ID ]; } $formatted_results[] = $user_info; } } } else { $formatted_results = iterator_to_array( ( function () use ( $users, $last_updates, $id_with_modified_date ) { foreach ( $users as $user ) { $user_info = array( 'id' => (int) $user->ID ); if ( $id_with_modified_date ) { if ( isset( $last_updates[ $user->ID ] ) && ! empty( $last_updates[ $user->ID ] ) ) { $user_info['date_modified_gmt'] = $last_updates[ $user->ID ]; } else { $user_info['date_modified_gmt'] = null; // users can have null date_modified_gmt. } } yield $user_info; } } )() ); } // Get the total number of orders for the given criteria. $total = \count( $formatted_results ); // Collect execution time and server load. $execution_time = microtime( true ) - $start_time; $execution_time_ms = number_format( $execution_time * 1000, 2 ); $server_load = $this->get_server_load(); $response = rest_ensure_response( $formatted_results ); $response->header( 'X-WP-Total', (string) $total ); $response->header( 'X-Execution-Time', $execution_time_ms . ' ms' ); $response->header( 'X-Server-Load', json_encode( $server_load ) ); return $response; } catch ( Exception $e ) { Logger::log( 'Error fetching order IDs: ' . $e->getMessage() ); return new WP_Error( 'woocommerce_pos_rest_cannot_fetch', 'Error fetching customer IDs.', array( 'status' => 500 ) ); } } /** * Filter arguments, before passing to WP_User_Query, when querying users via the REST API. * * @param array $prepared_args Array of arguments for WP_User_Query. * @param WP_REST_Request $request The current request. * * @return array $prepared_args Array of arguments for WP_User_Query. */ public function wcpos_customer_query( array $prepared_args, WP_REST_Request $request ): array { $query_params = $request->get_query_params(); // add modified_after date_modified_gmt. if ( isset( $query_params['modified_after'] ) && '' !== $query_params['modified_after'] ) { $timestamp = strtotime( $query_params['modified_after'] ); $prepared_args['meta_query'] = $this->wcpos_combine_meta_queries( array( array( 'key' => 'last_update', 'value' => $timestamp ? (string) $timestamp : '', 'compare' => '>', ), ), $prepared_args['meta_query'] ); } // Handle orderby cases. if ( isset( $query_params['orderby'] ) ) { switch ( $query_params['orderby'] ) { case 'first_name': $prepared_args['meta_key'] = 'first_name'; $prepared_args['orderby'] = 'meta_value'; break; case 'last_name': $prepared_args['meta_key'] = 'last_name'; $prepared_args['orderby'] = 'meta_value'; break; case 'email': $prepared_args['orderby'] = 'user_email'; break; case 'role': $prepared_args['meta_key'] = 'wp_capabilities'; $prepared_args['orderby'] = 'meta_value'; break; case 'username': $prepared_args['orderby'] = 'user_login'; break; default: break; } } // Handle search. if ( isset( $query_params['search'] ) && ! empty( $query_params['search'] ) ) { $search_keyword = $query_params['search']; /* * It seems that you can't search by user_email, user_login etc and meta_query at the same time. * * We will unset the search param and add a hook to modify the user query to search the user table */ unset( $prepared_args['search'] ); $prepared_args['_wcpos_search'] = $search_keyword; // store the search keyword for later use. add_action( 'pre_user_query', array( $this, 'wcpos_search_user_table' ) ); $search_meta_query = array( 'relation' => 'OR', array( 'key' => 'first_name', 'value' => $search_keyword, 'compare' => 'LIKE', ), array( 'key' => 'last_name', 'value' => $search_keyword, 'compare' => 'LIKE', ), // WooCommerce billing fields. array( 'key' => 'billing_first_name', 'value' => $search_keyword, 'compare' => 'LIKE', ), array( 'key' => 'billing_last_name', 'value' => $search_keyword, 'compare' => 'LIKE', ), array( 'key' => 'billing_email', 'value' => $search_keyword, 'compare' => 'LIKE', ), array( 'key' => 'billing_company', 'value' => $search_keyword, 'compare' => 'LIKE', ), array( 'key' => 'billing_phone', 'value' => $search_keyword, 'compare' => 'LIKE', ), ); foreach ( Tax_Id_Reader::fallback_user_meta_keys() as $meta_key ) { $search_meta_query[] = array( 'key' => $meta_key, 'value' => $search_keyword, 'compare' => 'LIKE', ); } // Combine the search meta_query with the existing meta_query. $prepared_args['meta_query'] = $this->wcpos_combine_meta_queries( $search_meta_query, $prepared_args['meta_query'] ); } // Handle include/exclude. if ( isset( $request['wcpos_include'] ) || isset( $request['wcpos_exclude'] ) ) { add_action( 'pre_user_query', array( $this, 'wcpos_include_exclude_users_by_id' ) ); } // Filter by roles (this is a comma separated list of roles). if ( ! empty( $request['roles'] ) && \is_array( $request['roles'] ) ) { $roles = array_map( 'sanitize_text_field', $request['roles'] ); $prepared_args['role__in'] = $roles; // remove $prepared_args['role'] to prevent it from overriding $prepared_args['role__in']. unset( $prepared_args['role'] ); } return $prepared_args; } /** * Add user_email and user_login to the user query. * * @param WP_User_Query $query The WP_User_Query instance (passed by reference). */ public function wcpos_search_user_table( $query ): void { global $wpdb; // Remove the hook. remove_action( 'pre_user_query', array( $this, 'wcpos_search_user_table' ) ); // Get the search keyword. $query_params = $query->query_vars; $search_keyword = $query_params['_wcpos_search']; // Prepare the LIKE statement. $like_email = '%' . $wpdb->esc_like( $search_keyword ) . '%'; $like_login = '%' . $wpdb->esc_like( $search_keyword ) . '%'; $insertion = $wpdb->prepare( "({$wpdb->users}.user_email LIKE %s) OR ({$wpdb->users}.user_login LIKE %s) OR ", $like_email, $like_login ); $pattern = "/\(\s*\w+\.meta_key\s*=\s*'[^']+'\s*AND\s*\w+\.meta_value\s*LIKE\s*'[^']+'\s*\)(\s*OR\s*\(\s*\w+\.meta_key\s*=\s*'[^']+'\s*AND\s*\w+\.meta_value\s*LIKE\s*'[^']+'\s*\))*\s*/"; // Add the search keyword to the query. $modified_where = preg_replace( $pattern, "$insertion$0", $query->query_where ); // Check if the replacement was successful and assign it back to query_where. if ( $modified_where !== $query->query_where ) { $query->query_where = $modified_where; } } /** * Include or exclude users by ID. * * @param WP_User_Query $query The WP_User_Query instance (passed by reference). */ public function wcpos_include_exclude_users_by_id( $query ): void { global $wpdb; // Remove the hook. remove_action( 'pre_user_query', array( $this, 'wcpos_include_exclude_users_by_id' ) ); // Handle 'wcpos_include'. if ( ! empty( $this->wcpos_request['wcpos_include'] ) ) { $include_ids = array_map( 'intval', (array) $this->wcpos_request['wcpos_include'] ); $ids_format = implode( ',', array_fill( 0, \count( $include_ids ), '%d' ) ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $ids_format is a safe placeholder string. $query->query_where .= $wpdb->prepare( " AND {$wpdb->users}.ID IN ($ids_format) ", $include_ids ); } // Handle 'wcpos_exclude'. if ( ! empty( $this->wcpos_request['wcpos_exclude'] ) ) { $exclude_ids = array_map( 'intval', (array) $this->wcpos_request['wcpos_exclude'] ); $ids_format = implode( ',', array_fill( 0, \count( $exclude_ids ), '%d' ) ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $ids_format is a safe placeholder string. $query->query_where .= $wpdb->prepare( " AND {$wpdb->users}.ID NOT IN ($ids_format) ", $exclude_ids ); } } /** * Allow the _woocommerce_pos_uuid meta key to be saved via the REST API. * * By default, meta keys starting with '_' are protected and cannot be set via the REST API. * We need to allow our UUID meta key so that UUIDs sent from the POS app are preserved. * * @param bool $protected Whether the meta key is considered protected. * @param string $meta_key The meta key being checked. * @param string $meta_type The type of object the meta is for (post, user, etc.). * * @return bool Whether the meta key should be protected. */ public function wcpos_allow_uuid_meta( $protected, $meta_key, $meta_type ) { if ( '_woocommerce_pos_uuid' === $meta_key && 'user' === $meta_type ) { return false; } return $protected; } }