t meta data for each payment. * * @since 1.8.2 * * @return array */ public function prepare_payment_meta() { $submitted_fields = $this->get_fields(); $user_info = $this->get_user_info( $submitted_fields ); /** * Payment meta that is ready to be saved into the payments_meta table. * * @since 1.8.2 * * @param array $payment_meta Payment meta that will be saved into the DB. * @param array $fields Final/sanitized submitted field data. * @param array $form_data Form data and settings. */ return (array) apply_filters( 'wpforms_forms_submission_prepare_payment_meta', [ 'fields' => ! $this->entry['entry_id'] ? wp_json_encode( $submitted_fields ) : '', 'user_id' => absint( $user_info['user_id'] ), 'user_agent' => sanitize_text_field( $user_info['user_agent'] ), 'user_uuid' => sanitize_text_field( $user_info['user_uuid'] ), 'ip_address' => sanitize_text_field( $user_info['user_ip'] ), ], $submitted_fields, $this->form_data ); } /** * Get entry fields. * * @since 1.8.2 * * @return array */ private function get_fields() { /** * Filter the entry data before saving. * * @since 1.0.0 * * @param array $fields Fields data. * @param array $entry Entry data. * @param array $form_data Form data. */ return (array) apply_filters( 'wpforms_entry_save_data', $this->fields, $this->entry, $this->form_data ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName } /** * Get user info. * * @since 1.8.2 * * @param array $fields Fields data. * * @return array */ private function get_user_info( $fields ) { $user_info = [ 'user_ip' => '', 'user_agent' => '', 'user_id' => is_user_logged_in() ? get_current_user_id() : 0, 'user_uuid' => wpforms_is_collecting_cookies_allowed() && ! empty( $_COOKIE['_wpfuuid'] ) ? sanitize_key( $_COOKIE['_wpfuuid'] ) : '', ]; /** * Allow developers disable saving user IP and User Agent within the entry. * * @since 1.5.1 * * @param bool $disable True if you need to disable storing IP and UA within the entry. Defaults to false. * @param array $fields Fields data. * @param array $form_data Form data. */ // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName $is_ip_disabled = apply_filters( 'wpforms_disable_entry_user_ip', '__return_false', $fields, $this->form_data ); // If GDPR enhancements are enabled and user details are disabled // globally or in the form settings, discard the IP and UA. if ( ! $is_ip_disabled || ! wpforms_is_collecting_ip_allowed( $this->form_data ) ) { return $user_info; } $user_info['user_ip'] = wpforms_get_ip(); if ( empty( $_SERVER['HTTP_USER_AGENT'] ) ) { return $user_info; } $user_info['user_agent'] = substr( sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ), 0, 256 ); return $user_info; } } }