Shipments

woocommerce_gzd_packing_item_subtotal_in_cents Filter

$param_1 string
$param_2 string

add_filter( "woocommerce_gzd_packing_item_subtotal_in_cents", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipments_init Action

add_action( "woocommerce_gzd_shipments_init", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_enable_rucksack_packaging Filter

$param bool

add_filter( "woocommerce_gzd_enable_rucksack_packaging", function( $param ) {
    // Do something
    return $param;    
}, 10, 1 );

woocommerce_gzd_shipment_base_country Filter

$param string

add_filter( "woocommerce_gzd_shipment_base_country", function( $param ) {
    // Do something
    return $param;    
}, 10, 1 );

woocommerce_gzd_shipment_base_postcode Filter

$param string

add_filter( "woocommerce_gzd_shipment_base_postcode", function( $param ) {
    // Do something
    return $param;    
}, 10, 1 );

woocommerce_gzd_country_belongs_to_eu_customs_area Filter

$param_1 string
$param_2 string
$param_3 string

add_filter( "woocommerce_gzd_country_belongs_to_eu_customs_area", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_shipments_updated Action

add_action( "woocommerce_gzd_shipments_updated", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_shipments_enable_logging Filter

$param string

add_filter( "woocommerce_gzd_shipments_enable_logging", function( $param ) {
    // Do something
    return $param;    
}, 10, 1 );

woocommerce_gzd_shipments_upload_dir Filter

Filter to adjust the upload directory used to store shipment related files. By default files are stored in a custom directory under wp-content/uploads.

$upload_dir array Array containing `wp_upload_dir` data.

add_filter( "woocommerce_gzd_shipments_upload_dir", function( $upload_dir ) {
    // Do something
    return $upload_dir;    
}, 10, 1 );

woocommerce_gzd_shipments_relative_upload_dir Filter

Filter to retrieve the relative upload path used for storing shipment related files.

$path array Relative path.

add_filter( "woocommerce_gzd_shipments_relative_upload_dir", function( $path ) {
    // Do something
    return $path;    
}, 10, 1 );

woocommerce_gzd_shipments_upload_path Filter

Filter to adjust the upload path used to store shipment related files. By default files are stored in a custom directory under wp-content/uploads.

$path string Path to the upload directory.

add_filter( "woocommerce_gzd_shipments_upload_path", function( $path ) {
    // Do something
    return $path;    
}, 10, 1 );

woocommerce_gzd_shipments_upload_url Filter

Filter to adjust the upload URL used to retrieve shipment related files. By default files are stored in a custom directory under wp-content/uploads.

$url string URL to the upload directory.

add_filter( "woocommerce_gzd_shipments_upload_url", function( $url ) {
    // Do something
    return $url;    
}, 10, 1 );

woocommerce_gzd_shipments_enabled Filter

$param bool

add_filter( "woocommerce_gzd_shipments_enabled", function( $param ) {
    // Do something
    return $param;    
}, 10, 1 );

woocommerce_gzd_shipments_registered_data_stores Action

add_action( "woocommerce_gzd_shipments_registered_data_stores", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_shipments_embed_shipment_details_in_notification Filter

$param_1 string
$param_2 string

add_filter( "woocommerce_gzd_shipments_embed_shipment_details_in_notification", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_query_args Filter

Filter to adjust query arguments passed to a Shipment query.

$args array The arguments passed.

add_filter( "woocommerce_gzd_shipment_query_args", function( $args ) {
    // Do something
    return $args;    
}, 10, 1 );

woocommerce_gzd_shipment_query Filter

Filter to adjust the Shipment query result.

$results \Vendidero\Germanized\Shipments\Shipment[] Shipment results.
$args array The arguments passed.

add_filter( "woocommerce_gzd_shipment_query", function( $results, $args ) {
    // Do something
    return $results;    
}, 10, 2 );

woocommerce_gzd_shipment_query_clauses Filter

$param_1 string
$param_2 string

add_filter( "woocommerce_gzd_shipment_query_clauses", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_search_columns Filter

Filters the columns to search in a ShipmentQuery search. The default columns depend on the search term, and include ‘shipment_id’, ‘shipment_country’, ‘shipment_tracking_id’, ‘shipment_order_id’, ‘shipment_shipping_provider’ and ‘shipment_shipping_method’.

$search_columns string[] Array of column names to be searched.
$search string Text being searched.
$this \Vendidero\Germanized\Shipments\ShipmentQuery The current ShipmentQuery instance.

add_filter( "woocommerce_gzd_shipment_search_columns", function( $search_columns, $search, $this ) {
    // Do something
    return $search_columns;    
}, 10, 3 );

woocommerce_gzd_shipment_label_shipping_provider_name Filter

$param_1 string
$param_2 string
$param_3 string

add_filter( "woocommerce_gzd_shipment_label_shipping_provider_name", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_shipment_label_class Filter

Filter that allows adjusting the default DHL label classname.

$classname string The classname to be used.
$label_id int The label id.
$label_type string The label type.
$param_4 string

add_filter( "woocommerce_gzd_shipment_label_class", function( $classname, $label_id, $label_type, $param_4 ) {
    // Do something
    return $classname;    
}, 10, 4 );

woocommerce_gzd_shipment_label_query_args Filter

Filter to adjust query paramaters for a DHL label query.

$query_vars array The query arguments.

add_filter( "woocommerce_gzd_shipment_label_query_args", function( $query_vars ) {
    // Do something
    return $query_vars;    
}, 10, 1 );

woocommerce_gzd_shipment_label_query Filter

Filter to adjust query result data for a DHL label query.

$results \Vendidero\Germanized\Shipments\Labels\Label[] The results.
$args array The query arguments.

add_filter( "woocommerce_gzd_shipment_label_query", function( $results, $args ) {
    // Do something
    return $results;    
}, 10, 2 );

woocommerce_gzd_shipment_label_search_columns Filter

Filters the columns to search in a DHL LabelQuery search. The default columns depend on the search term, and include ‘label_id’, ‘label_shipment_id’, ‘label_path’ and ‘label_number’.

$search_columns string[] Array of column names to be searched.
$search string Text being searched.
$this \Vendidero\Germanized\Shipments\Labels\LabelQuery The current LabelQuery instance.

add_filter( "woocommerce_gzd_shipment_label_search_columns", function( $search_columns, $search, $this ) {
    // Do something
    return $search_columns;    
}, 10, 3 );

woocommerce_gzd_shipments_order_has_voucher Filter

$param_1 bool
$param_2 string

add_filter( "woocommerce_gzd_shipments_order_has_voucher", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipments_customs_use_subtotal Filter

$param_1 string
$param_2 string

add_filter( "woocommerce_gzd_shipments_customs_use_subtotal", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipments_label_customs_data Filter

$param_1 string
$param_2 string
$param_3 string
$param_4 string

add_filter( "woocommerce_gzd_shipments_label_customs_data", function( $param_1, $param_2, $param_3, $param_4 ) {
    // Do something
    return $param_1;    
}, 10, 4 );

woocommerce_gzd_shipments_disable_label_auto_generate Filter

Filter that allows to disable automatically creating DHL labels for a certain shipment.

$disable bool True if you want to disable automation.
$shipment \Vendidero\Germanized\Shipments\Shipment The shipment object.

add_filter( "woocommerce_gzd_shipments_disable_label_auto_generate", function( $disable, $shipment ) {
    // Do something
    return $disable;    
}, 10, 2 );

woocommerce_gzd_shipments_order_shipped Action

Action that fires as soon as an order has been shipped completely. That is the case when the order contains all relevant shipments and all the shipments are marked as shipped.

$order_id string The order id.

add_action( "woocommerce_gzd_shipments_order_shipped", function( $order_id ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_item_visible Filter

$param_1 bool
$param_2 string

add_filter( "woocommerce_gzd_shipment_item_visible", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_item_permalink Filter

This filter is documented in templates/myaccount/shipment/shipment-details-item.php

$param_1 string
$param_2 string
$param_3 string

add_filter( "woocommerce_gzd_shipment_item_permalink", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_shipment_item_name Filter

$param_1 string
$param_2 string
$param_3 bool

add_filter( "woocommerce_gzd_shipment_item_name", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_shipment_item_quantity_html Filter

This filter may adjust the shipment item quantity HTML on the customer account page.

$html string The HTML output.
$item \Vendidero\Germanized\Shipments\ShipmentItem The shipment item instance.

add_filter( "woocommerce_gzd_shipment_item_quantity_html", function( $html, $item ) {
    // Do something
    return $html;    
}, 10, 2 );

woocommerce_gzd_shipment_details_after_tracking_details Action

This action is executed after printing the shipment tracking details on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_after_tracking_details", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_details_before_shipment_table Action

This action is executed before printing the shipment detail table on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_before_shipment_table", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_details_before_shipment_table_items Action

This action is executed before printing the shipment table items on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_before_shipment_table_items", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_details_after_shipment_table_items Action

This action is executed after printing the shipment table items on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_after_shipment_table_items", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_details_after_shipment_table Action

This action is executed after printing the shipment detail table on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_after_shipment_table", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipment_details_after_address_details Action

This action is executed after printing the shipment address details on the customer account page.

$shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.

add_action( "woocommerce_gzd_shipment_details_after_address_details", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_return_shipment_after_instructions Action

This action is executed after printing the return shipment instructions.

$shipment \Vendidero\Germanized\Shipments\ReturnShipment The shipment instance.

add_action( "woocommerce_gzd_return_shipment_after_instructions", function( $shipment ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_return_request_form_start Action

add_action( "woocommerce_gzd_return_request_form_start", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_return_request_form Action

add_action( "woocommerce_gzd_return_request_form", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_return_request_form_end Action

add_action( "woocommerce_gzd_return_request_form_end", function(  ) {
    // Do something
        
}, 10 );

woocommerce_gzd_before_account_shipments Action

$param_1 string
$param_2 string

add_action( "woocommerce_gzd_before_account_shipments", function( $param_1, $param_2 ) {
    // Do something
        
}, 10, 2 );

woocommerce_gzd_my_account_shipments_column_{$column_id} Action

$param_1 string
$param_2 string

woocommerce_gzd_after_account_shipments Action

This action is executed after listing all available shipments for an order on the customer account page.

$shipments \Vendidero\Germanized\Shipments\Shipment[] Array of shipments.

add_action( "woocommerce_gzd_after_account_shipments", function( $shipments ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_add_return_shipment_details_before_shipment_table_items Action

This action is executed before printing the add return shipment table on the customer account page.

$order \WC_Order The order instance.

add_action( "woocommerce_gzd_add_return_shipment_details_before_shipment_table_items", function( $order ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_add_return_shipment_details_after_shipment_table_items Action

This action is executed after printing the add return shipment table items on the customer account page.

$order \WC_Order The order instance.

add_action( "woocommerce_gzd_add_return_shipment_details_after_shipment_table_items", function( $order ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_add_return_shipment_details_after_shipment_table Action

This action is executed after printing the return shipment table on the customer account page.

$order \WC_Order The order instance.

add_action( "woocommerce_gzd_add_return_shipment_details_after_shipment_table", function( $order ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_add_return_shipment Action

This action is executed after printing the add return shipment form on the customer account page.

$order_id int The order id.

add_action( "woocommerce_gzd_add_return_shipment", function( $order_id ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_view_shipment Action

This action is executed after printing the shipment details on the customer account page.

$shipment_id int The shipment id.

add_action( "woocommerce_gzd_view_shipment", function( $shipment_id ) {
    // Do something
        
}, 10, 1 );

Login