Hook action và filter

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

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

Hai filter ghn_tracking_order_priority và ghnauto_option được đọc ngay lúc plugin khởi động, trước khi theme nạp — muốn chúng có tác dụng thì đặt trong một file ở wp-content/mu-plugins/.

Action

Filter — phí vận chuyển và gói cước

Filter — khối lượng và kích thước

Filter — tạo vận đơn

Filter — email, tra cứu, gỡ lỗi

Filter — module trang thanh toán

Hook của addon đăng đơn tự động/hàng loạt

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

Có trong mã nguồn nhưng không chạy

Bạn có thể thấy các tên dưới đây khi đọc mã nguồn, nhưng ở bản 3.5.0 chúng không bao giờ được gọi — móc vào sẽ không có tác dụng gì:

• ghn_custom_field — thuộc hàm trường thanh toán cũ, không còn gắn vào đâu.
• devvn_notecode_default — chỉ nằm trong đoạn cập nhật vận đơn kiểu cũ không còn dùng. Ghi chú bắt buộc mặc định chỉnh ở tab Cài đặt GHN.
• ghn_template_path, ghn_get_template, ghn_locate_template, ghn_before_template_part, ghn_after_template_part — hàm nạp template của plugin không được gọi ở đâu, nên không ghi đè template bằng theme được.

Ví dụ hay dùng

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

devvn_ghn_rate không chạm được giá thật, nên dùng filter của WooCommerce. Phương thức GHN có mã ghn_shipping_method; điều kiện get_cost() > 0 để bỏ qua dòng "báo sau".

add_filter( 'woocommerce_package_rates', function ( $rates ) {
    foreach ( $rates as $rate ) {
        if ( 'ghn_shipping_method' === $rate->get_method_id() && $rate->get_cost() > 0 ) {
            $rate->set_cost( $rate->get_cost() + 5000 );
        }
    }
    return $rates;
} );

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

add_filter( 'woocommerce_package_rates', function ( $rates ) {
    $user = wp_get_current_user();
    if ( ! in_array( 'vip_customer', (array) $user->roles, true ) ) {
        return $rates;
    }
    foreach ( $rates as $rate ) {
        if ( 'ghn_shipping_method' === $rate->get_method_id() ) {
            $rate->set_cost( 0 );
        }
    }
    return $rates;
} );

WooCommerce lưu tạm kết quả phí ship trong phiên của khách. Thêm hoặc sửa đoạn code xong, hãy đổi địa chỉ hay số lượng trong giỏ để phí được tính lại khi kiểm tra.

Không cho khách chọn gói Hàng nặng

add_filter( 'ghn_exclude_service', function ( $types ) {
    $types[] = 5; // service_type_id: 2 = Hàng nhẹ, 5 = Hàng nặng
    return $types;
} );

Đổi tên gói hiện ở trang thanh toán

add_filter( 'ghn_service_name', function ( $name ) {
    if ( 'Hàng nhẹ' === $name ) {
        return 'Giao Hàng Nhanh (GHN)';
    }
    return $name;
} );

Cộng thêm khối lượng bao bì khi tính phí

add_filter( 'wc_devvn_cart_contents_weight', function ( $weight ) {
    return $weight + 100; // gram
} );

Thêm lời nhắn cố định vào ghi chú vận đơn

Ghép thêm một câu vào ghi chú vận đơn (note), giữ nguyên ghi chú đã có. Một hook là đủ cho cả đơn tạo tay lẫn đơn addon đăng.

add_filter( 'ghn_pre_data_before_create_order', function ( $data, $order ) {
    $data['note'] = trim( $data['note'] . ' Goi truoc khi giao 15 phut' );
    return $data;
}, 10, 2 );

Tên khoá trong $data theo tài liệu API tạo đơn của GHN tại developer.ghn.vn.

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

Đọc meta qua đối tượng đơn để chạy đúng cả khi bật HPOS (bảng đơn hàng mới) lẫn kho đơn cũ.

add_action( 'devvn_after_ghn_create_order', function ( $order_id ) {
    $order = wc_get_order( $order_id );
    if ( ! $order ) {
        return;
    }
    $tracking = $order->get_meta( '_ghn_ordercode' );
    if ( $tracking ) {
        error_log( 'Don ' . $order_id . ' co ma van don ' . $tracking );
    }
} );

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

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

Không chép mã vận đơn GHN khi tách đơn

add_filter( 'devvn_split_order_exclude_meta', function ( $keys ) {
    return array_merge( $keys, array(
        '_ghn_ordercode',
        '_ghn_order_fullinfor',
        '_ghn_order_submited',
        '_ghn_order_status',
        'ghn_auto_status',
        'ghn_auto_info',
    ) );
} );

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