Hook action và filter

Đặt code ở đâu

Đặt trong functions.php của child theme, hoặc tốt hơn là một plugin nhỏ riêng để đổi giao diện không mất code. Đừng sửa file trong thư mục plugin, mọi thay đổi sẽ mất khi cập nhật.

Riêng filter kiotviet_sync_option được đọc ngay lúc plugin nạp, trước khi theme nạp. Muốn nó có tác dụng thì đặt trong một file ở wp-content/mu-plugins/.

Phần trang thanh toán Việt Nam ở tab Cài đặt chung là module dùng chung với các plugin DevVN khác, có hook riêng và không liệt kê ở bài này.

Action

Bản 1.3.4 không có action riêng nào chạy trước hay sau khi đồng bộ sản phẩm hoặc đăng đơn. Cần biết một bản ghi đã liên kết KiotViet chưa thì đọc meta plugin lưu:

Đơn hàng đọc meta bằng $order->get_meta( '_kiotviet_order_code' ), chạy được cả khi bật HPOS.

Filter: dữ liệu đơn gửi lên KiotViet

Tham số $context là 'create' khi đăng đơn mới, 'update' khi cập nhật. Tham số $shipping_data là dữ liệu từ hộp thoại đăng đơn hoặc từ luồng tự động; $shipping_data['auto_sync'] bằng true khi đơn được tự động đăng.

Filter: địa chỉ gửi lên KiotViet

Filter: khách hàng, sản phẩm, cài đặt

Ví dụ hay dùng

Mỗi đoạn dưới đây chép nguyên vào child theme hoặc plugin riêng là chạy, chỉ thay các giá trị đánh dấu.

Đơn nhận tại cửa hàng vào chi nhánh khác

Mọi đơn vào Chi nhánh mặc định. Đoạn này đưa đơn chọn nhận tại cửa hàng sang chi nhánh khác. ID chi nhánh xem bằng cách bấm chuột phải vào ô Chi nhánh mặc định, chọn Kiểm tra (Inspect) rồi đọc thuộc tính value của từng lựa chọn.

add_filter( 'devvn_kiotviet_sync_order_payload', function ( $payload, $order, $shipping_data, $context ) {
    if ( $order->has_shipping_method( 'local_pickup' ) || $order->has_shipping_method( 'pickup_location' ) ) {
        $payload['branchId'] = 123456; // ID chi nhánh trên KiotViet
    }
    return $payload;
}, 10, 4 );

Thêm hình thức thanh toán vào ghi chú khi tự động đăng

add_filter( 'devvn_kiotviet_sync_order_description', function ( $description, $order, $shipping_data, $context ) {
    if ( empty( $shipping_data['auto_sync'] ) ) {
        return $description;
    }
    return trim( $description . "\n" . 'Thanh toán: ' . $order->get_payment_method_title() );
}, 10, 4 );

Đơn đăng bằng hộp thoại giữ nguyên ghi chú bạn gõ, vì điều kiện auto_sync chỉ đúng khi đơn được tự động đăng.

Coi đơn Đang xử lý là đã thanh toán

Mặc định chỉ đơn Hoàn thành được gửi lên với số tiền khách đã trả bằng tổng đơn. Cổng thanh toán online thường để đơn ở Đang xử lý sau khi nhận tiền:

add_filter( 'devvn_kiotviet_sync_order_has_paid_statuses', function ( $statuses ) {
    $statuses[] = 'processing';
    return $statuses;
} );

Filter áp cho mọi đơn không thu tiền khi nhận hàng. Website có đơn chuyển khoản tay được chuyển sang Đang xử lý trước khi nhận tiền thì đừng dùng đoạn này.

Gửi tổng khối lượng cả đơn khi tự động đăng

Đoạn này cộng khối lượng mọi dòng sản phẩm nhân số lượng, đổi sang gram theo đơn vị cân nặng của cửa hàng:

add_filter( 'devvn_kiotviet_sync_order_delivery', function ( $delivery, $order, $shipping_data, $context ) {
    if ( empty( $shipping_data['auto_sync'] ) ) {
        return $delivery;
    }
    $weight = 0;
    foreach ( $order->get_items() as $item ) {
        $product = $item->get_product();
        if ( $product && $product->get_weight() ) {
            $weight += (float) $product->get_weight() * $item->get_quantity();
        }
    }
    if ( $weight > 0 ) {
        $delivery['weight'] = (float) wc_get_weight( $weight, 'g' );
    }
    return $delivery;
}, 10, 4 );

Đổi tên phường/xã mà KiotViet không nhận

Khoá là tên đang có trên web (hoặc tên sau khi plugin chuẩn hoá), giá trị là tên đúng như danh mục khu vực, phường/xã trên KiotViet:

add_filter( 'devvn_kiotviet_sync_location_name_map', function ( $map, $address ) {
    $map['Phường Tên Trên Web'] = 'Phường Tên Trên KiotViet';
    return $map;
}, 10, 2 );

Bỏ bước Đồng bộ khách hàng khỏi tab Bắt đầu

Cửa hàng không dùng đồng bộ khách hàng thì bước 9 luôn báo Chưa làm và bộ đếm không bao giờ đủ. Đoạn này bỏ bước đó khỏi danh sách:

add_filter( 'devvn_kiotviet_sync_setup_steps', function ( $steps ) {
    return array_values( array_filter( $steps, function ( $step ) {
        return 'customer-sync' !== $step['id'];
    } ) );
} );

Còn vướng chỗ nào thì xem Giải đáp thắc mắc.