WC_Privacy_Exporters::get_order_personal_data( WC_Order $order )

Get personal data (key/value pairs) for an order object.


Description Description


Parameters Parameters

$order

(Required) Order object.


Top ↑

Return Return

(array)


Top ↑

Source Source

File: includes/class-wc-privacy-exporters.php

245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
protected static function get_order_personal_data( $order ) {
    $personal_data   = array();
    $props_to_export = apply_filters(
        'woocommerce_privacy_export_order_personal_data_props',
        array(
            'order_number'               => __( 'Order Number', 'woocommerce' ),
            'date_created'               => __( 'Order Date', 'woocommerce' ),
            'total'                      => __( 'Order Total', 'woocommerce' ),
            'items'                      => __( 'Items Purchased', 'woocommerce' ),
            'customer_ip_address'        => __( 'IP Address', 'woocommerce' ),
            'customer_user_agent'        => __( 'Browser User Agent', 'woocommerce' ),
            'formatted_billing_address'  => __( 'Billing Address', 'woocommerce' ),
            'formatted_shipping_address' => __( 'Shipping Address', 'woocommerce' ),
            'billing_phone'              => __( 'Phone Number', 'woocommerce' ),
            'billing_email'              => __( 'Email Address', 'woocommerce' ),
        ),
        $order
    );
 
    foreach ( $props_to_export as $prop => $name ) {
        $value = '';
 
        switch ( $prop ) {
            case 'items':
                $item_names = array();
                foreach ( $order->get_items() as $item ) {
                    $item_names[] = $item->get_name() . ' x ' . $item->get_quantity();
                }
                $value = implode( ', ', $item_names );
                break;
            case 'date_created':
                $value = wc_format_datetime( $order->get_date_created(), get_option( 'date_format' ) . ', ' . get_option( 'time_format' ) );
                break;
            case 'formatted_billing_address':
            case 'formatted_shipping_address':
                $value = preg_replace( '#<br\s*/?>#i', ', ', $order->{"get_$prop"}() );
                break;
            default:
                if ( is_callable( array( $order, 'get_' . $prop ) ) ) {
                    $value = $order->{"get_$prop"}();
                }
                break;
        }
 
        $value = apply_filters( 'woocommerce_privacy_export_order_personal_data_prop', $value, $prop, $order );
 
        if ( $value ) {
            $personal_data[] = array(
                'name'  => $name,
                'value' => $value,
            );
        }
    }
 
    // Export meta data.
    $meta_to_export = apply_filters(
        'woocommerce_privacy_export_order_personal_data_meta',
        array(
            'Payer first name'     => __( 'Payer first name', 'woocommerce' ),
            'Payer last name'      => __( 'Payer last name', 'woocommerce' ),
            'Payer PayPal address' => __( 'Payer PayPal address', 'woocommerce' ),
            'Transaction ID'       => __( 'Transaction ID', 'woocommerce' ),
        )
    );
 
    if ( ! empty( $meta_to_export ) && is_array( $meta_to_export ) ) {
        foreach ( $meta_to_export as $meta_key => $name ) {
            $value = apply_filters( 'woocommerce_privacy_export_order_personal_data_meta_value', $order->get_meta( $meta_key ), $meta_key, $order );
 
            if ( $value ) {
                $personal_data[] = array(
                    'name'  => $name,
                    'value' => $value,
                );
            }
        }
    }
 
    /**
     * Allow extensions to register their own personal data for this order for the export.
     *
     * @since 3.4.0
     * @param array    $personal_data Array of name value pairs to expose in the export.
     * @param WC_Order $order An order object.
     */
    $personal_data = apply_filters( 'woocommerce_privacy_export_order_personal_data', $personal_data, $order );
 
    return $personal_data;
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.4.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.