get_meta_data(); $metadata_to_list = array(); foreach ( $metadata as $meta ) { $data = $meta->get_data(); if ( is_protected_meta( $data['key'], 'order' ) ) { continue; } $metadata_to_list[] = array( 'meta_id' => $data['id'], 'meta_key' => $data['key'], // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- False positive, not a meta query. 'meta_value' => maybe_serialize( $data['value'] ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- False positive, not a meta query. ); } return $metadata_to_list; } /** * Renders the meta box to manage custom meta. * * @param \WP_Post|\WC_Order $order_or_post Post or order object that we are rendering for. */ public function output( $order_or_post ) { if ( is_a( $order_or_post, \WP_Post::class ) ) { $order = wc_get_order( $order_or_post ); } else { $order = $order_or_post; } $this->render_custom_meta_form( $this->get_formatted_order_meta_data( $order ), $order ); } /** * Helper method to render layout and actual HTML * * @param array $metadata_to_list List of metadata to render. * @param \WC_Order $order Order object. */ private function render_custom_meta_form( array $metadata_to_list, \WC_Order $order ) { ?>
render_meta_form( $order ); ?>

', '' ); ?>

get( OrdersTableDataStoreMeta::class )->get_meta_keys( $limit ); } if ( $keys ) { natcasesort( $keys ); } return $keys; } /** * Reimplementation of WP core's `meta_form` function. Renders meta form box. * * @param \WC_Order $order WC_Order object. * * @return void */ public function render_meta_form( \WC_Order $order ) : void { ?>

'newmeta-submit', 'data-wp-lists' => 'add:the-list:newmeta', ) ); ?>
order_meta_keys_autofill( null, $order ); wp_send_json( $found_order_meta_keys ); } /** * Reimplementation of WP core's `wp_ajax_add_meta` method to support order custom meta updates with custom tables. */ public function add_meta_ajax() { if ( ! check_ajax_referer( 'add-meta', '_ajax_nonce-add-meta' ) ) { wp_send_json_error( 'invalid_nonce' ); wp_die(); } $order_id = (int) $_POST['order_id'] ?? 0; $order = $this->verify_order_edit_permission_for_ajax( $order_id ); $select_meta_key = trim( sanitize_text_field( wp_unslash( $_POST['metakeyselect'] ?? '' ) ) ); $input_meta_key = trim( sanitize_text_field( wp_unslash( $_POST['metakeyinput'] ?? '' ) ) ); if ( empty( $_POST['meta'] ) && in_array( $select_meta_key, array( '', '#NONE#' ), true ) && ! $input_meta_key ) { wp_die( 1 ); } if ( ! empty( $_POST['meta'] ) ) { // update. $meta = wp_unslash( $_POST['meta'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- sanitization done below in array_walk. $this->handle_update_meta( $order, $meta ); } else { // add meta. $meta_value = sanitize_text_field( wp_unslash( $_POST['metavalue'] ?? '' ) ); $meta_key = $input_meta_key ? $input_meta_key : $select_meta_key; $this->handle_add_meta( $order, $meta_key, $meta_value ); } } /** * Part of WP Core's `wp_ajax_add_meta`. This is re-implemented to support updating meta for custom tables. * * @param WC_Order $order Order object. * @param string $meta_key Meta key. * @param string $meta_value Meta value. * * @return void */ private function handle_add_meta( WC_Order $order, string $meta_key, string $meta_value ) { $count = 0; if ( is_protected_meta( $meta_key ) ) { wp_send_json_error( 'protected_meta' ); wp_die(); } $metas_for_current_key = wp_list_filter( $order->get_meta_data(), array( 'key' => $meta_key ) ); $meta_ids = wp_list_pluck( $metas_for_current_key, 'id' ); $order->add_meta_data( $meta_key, $meta_value ); $order->save_meta_data(); $metas_for_current_key_with_new = wp_list_filter( $order->get_meta_data(), array( 'key' => $meta_key ) ); $meta_id = 0; $new_meta_ids = wp_list_pluck( $metas_for_current_key_with_new, 'id' ); $new_meta_ids = array_values( array_diff( $new_meta_ids, $meta_ids ) ); if ( count( $new_meta_ids ) > 0 ) { $meta_id = $new_meta_ids[0]; } $response = new WP_Ajax_Response( array( 'what' => 'meta', 'id' => $meta_id, 'data' => $this->list_meta_row( array( 'meta_id' => $meta_id, 'meta_key' => $meta_key, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- false positive, not a meta query. 'meta_value' => $meta_value, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- false positive, not a meta query. ), $count ), 'position' => 1, ) ); $response->send(); } /** * Handles updating metadata. * * @param WC_Order $order Order object. * @param array $meta Meta object to update. * * @return void */ private function handle_update_meta( WC_Order $order, array $meta ) { if ( ! is_array( $meta ) ) { wp_send_json_error( 'invalid_meta' ); wp_die(); } array_walk( $meta, 'sanitize_text_field' ); $mid = (int) key( $meta ); if ( ! $mid ) { wp_send_json_error( 'invalid_meta_id' ); wp_die(); } $key = $meta[ $mid ]['key']; $value = $meta[ $mid ]['value']; if ( is_protected_meta( $key ) ) { wp_send_json_error( 'protected_meta' ); wp_die(); } if ( '' === trim( $key ) ) { wp_send_json_error( 'invalid_meta_key' ); wp_die(); } $count = 0; $order->update_meta_data( $key, $value, $mid ); $order->save_meta_data(); $response = new WP_Ajax_Response( array( 'what' => 'meta', 'id' => $mid, 'old_id' => $mid, 'data' => $this->list_meta_row( array( 'meta_key' => $key, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- false positive, not a meta query. 'meta_value' => $value, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- false positive, not a meta query. 'meta_id' => $mid, ), $count ), 'position' => 0, ) ); $response->send(); } /** * Outputs a single row of public meta data in the Custom Fields meta box. * * @since 2.5.0 * * @param array $entry Meta entry. * @param int $count Sequence number of meta entries. * @return string */ private function list_meta_row( array $entry, int &$count ) : string { if ( is_protected_meta( $entry['meta_key'], 'post' ) ) { return ''; } if ( ! $this->update_nonce ) { $this->update_nonce = wp_create_nonce( 'add-meta' ); } $r = ''; ++ $count; if ( is_serialized( $entry['meta_value'] ) ) { if ( is_serialized_string( $entry['meta_value'] ) ) { // This is a serialized string, so we should display it. $entry['meta_value'] = maybe_unserialize( $entry['meta_value'] ); // // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- false positive, not a meta query. } else { // This is a serialized array/object so we should NOT display it. --$count; return ''; } } $entry['meta_key'] = esc_attr( $entry['meta_key'] ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- false positive, not a meta query. $entry['meta_value'] = esc_textarea( $entry['meta_value'] ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- false positive, not a meta query. $entry['meta_id'] = (int) $entry['meta_id']; $delete_nonce = wp_create_nonce( 'delete-meta_' . $entry['meta_id'] ); $r .= "\n\t"; $r .= "\n\t\t"; $r .= "\n\t\t
"; $r .= get_submit_button( __( 'Delete', 'woocommerce' ), 'deletemeta small', "deletemeta[{$entry['meta_id']}]", false, array( 'data-wp-lists' => "delete:the-list:meta-{$entry['meta_id']}::_ajax_nonce=$delete_nonce" ) ); $r .= "\n\t\t"; $r .= get_submit_button( __( 'Update', 'woocommerce' ), 'updatemeta small', "meta-{$entry['meta_id']}-submit", false, array( 'data-wp-lists' => "add:the-list:meta-{$entry['meta_id']}::_ajax_nonce-add-meta={$this->update_nonce}" ) ); $r .= '
'; $r .= wp_nonce_field( 'change-meta', '_ajax_nonce', false, false ); $r .= ''; $r .= "\n\t\t\n\t"; return $r; } /** * Reimplementation of WP core's `wp_ajax_delete_meta` method to support order custom meta updates with custom tables. * * @return void */ public function delete_meta_ajax() { $meta_id = (int) $_POST['id'] ?? 0; $order_id = (int) $_POST['order_id'] ?? 0; if ( ! $meta_id || ! $order_id ) { wp_send_json_error( 'invalid_meta_id' ); wp_die(); } check_ajax_referer( "delete-meta_$meta_id" ); $order = $this->verify_order_edit_permission_for_ajax( $order_id ); $meta_to_delete = wp_list_filter( $order->get_meta_data(), array( 'id' => $meta_id ) ); if ( empty( $meta_to_delete ) ) { wp_send_json_error( 'invalid_meta_id' ); wp_die(); } $order->delete_meta_data_by_mid( $meta_id ); if ( $order->save() ) { wp_die( 1 ); } wp_die( 0 ); } /** * Handle the possible changes in order metadata coming from an order edit page in admin * (labeled "custom fields" in the UI). * * This method expects the $_POST array to contain a 'meta' key that is an associative * array of [meta item id => [ 'key' => meta item name, 'value' => meta item value ]; * and also to contain (possibly empty) 'metakeyinput' and 'metavalue' keys. * * @param WC_Order $order The order to handle. */ public function handle_metadata_changes( $order ) { $has_meta_changes = false; $order_meta = $order->get_meta_data(); $order_meta = array_combine( array_map( fn( $meta ) => $meta->id, $order_meta ), $order_meta ); // phpcs:disable WordPress.Security.ValidatedSanitizedInput, WordPress.Security.NonceVerification.Missing foreach ( ( $_POST['meta'] ?? array() ) as $request_meta_id => $request_meta_data ) { $request_meta_id = wp_unslash( $request_meta_id ); $request_meta_key = wp_unslash( $request_meta_data['key'] ); $request_meta_value = wp_unslash( $request_meta_data['value'] ); if ( array_key_exists( $request_meta_id, $order_meta ) && ( $order_meta[ $request_meta_id ]->key !== $request_meta_key || $order_meta[ $request_meta_id ]->value !== $request_meta_value ) ) { $order->update_meta_data( $request_meta_key, $request_meta_value, $request_meta_id ); $has_meta_changes = true; } } $request_new_key = wp_unslash( $_POST['metakeyinput'] ?? '' ); $request_new_value = wp_unslash( $_POST['metavalue'] ?? '' ); if ( '' !== $request_new_key ) { $order->add_meta_data( $request_new_key, $request_new_value ); $has_meta_changes = true; } // phpcs:enable WordPress.Security.ValidatedSanitizedInput, WordPress.Security.NonceVerification.Missing if ( $has_meta_changes ) { $order->save(); } } }