Hook action và filter

Cần hiểu luồng API phía sau (token, tính cước, tạo đơn, huỷ đơn)? Xem bài tích hợp API Viettel Post bằng PHP.

Xem video

Đặ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.

Action

Filter — phí vận chuyển

Filter — khối lượng và kho

Filter — tạo vận đơn bằng tay

Filter — addon đăng đơn tự động/hàng loạt

Chỉ có khi đã cài addon đăng đơn tự động/hàng loạt.

Filter — trạng thái, email và gỡ lỗi

Ví dụ hay dùng

Cộng thêm phụ phí đóng gói vào phí ship

add_filter( 'viettelpost_money_total', function ( $cost, $rate ) {
    return $cost + 5000;
}, 10, 2 );

Miễn phí ship cho một hạng khách hàng

add_filter( 'viettelpost_money_total', function ( $cost, $rate ) {
    $user = wp_get_current_user();
    if ( in_array( 'vip_customer', (array) $user->roles, true ) ) {
        return 0;
    }
    return $cost;
}, 10, 2 );

Bỏ quy đổi khối lượng theo kích thước ở trang thanh toán

Dùng khi muốn phí báo cho khách chỉ tính theo cân nặng thật. Quy đổi chỉ làm phí tăng khi khối lượng quy đổi lớn hơn cân nặng thật (hàng nhẹ mà cồng kềnh); cước ViettelPost thu thực tế vẫn theo cách họ cân đo khi nhận hàng.

add_filter( 'skip_weight_conversion', '__return_true' );

Thêm lời nhắn cố định cho bưu tá trên mọi vận đơn

Ghép thêm một câu vào ghi chú vận đơn (ORDER_NOTE), giữ nguyên ghi chú đã có. Hai hook vì đơn tạo tay và đơn addon đăng tự động đi hai đường khác nhau.

function my_vtp_add_note( $data ) {
    $data['ORDER_NOTE'] = trim( $data['ORDER_NOTE'] . ' Cho xem hang, khong cho thu' );
    return $data;
}
add_filter( 'vtp_data_before_create_order', 'my_vtp_add_note' );          // tạo tay
add_filter( 'vtpauto_pre_data_before_create_order', 'my_vtp_add_note' );  // addon tự động/hàng loạt

Tên khoá trong $data theo đúng tài liệu API của ViettelPost. Bật vtp_debug rồi tạo thử một vận đơn để xem cấu trúc thật trước khi sửa.

Chọn sẵn một kho gửi cho đơn của vài tỉnh

Mã tỉnh là mã của plugin, viết hoa không dấu như HANOI, HOCHIMINH, DANANG. Hook này chỉ đổi kho chọn sẵn trong hộp thoại tạo vận đơn.

add_filter( 'vtp_store_default', function ( $hub_id, $order ) {
    if ( in_array( $order->get_shipping_state(), array( 'DANANG', 'QUANGNGAI' ), true ) ) {
        return '10000002';
    }
    return $hub_id;
}, 10, 2 );

Ghi lại mã vận đơn sang hệ thống khác

add_action( 'devvn_after_vtp_create_order', function ( $order ) {
    $tracking = $order->get_meta( 'vtpost_order_number' );
    if ( $tracking ) {
        error_log( 'Don ' . $order->get_id() . ' co ma van don ' . $tracking );
    }
} );

Thêm mã thay thế của riêng bạn vào email

add_filter( 'mail_string_filter', function ( $string, $order ) {
    return str_replace( '{hotline}', '0965 419 096', $string );
}, 10, 2 );

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