• Germanized
  • Hooks

Shipments

woocommerce_gzd_shipment_item_updated Action

Action that indicates that a ShipmentItem has been updated in the DB.

  1. $shipment_item_id int The shipment item id.
  2. $item \Vendidero\Germanized\Shipments\ShipmentItem The shipment item object.
  3. $shipment_id int The shipment id.
add_action( "woocommerce_gzd_shipment_item_updated", function( $shipment_item_id, $item, $shipment_id ) {
    // Do something
        
}, 10, 3 );

woocommerce_gzd_before_delete_shipment_item Action

Action that fires before deleting a ShipmentItem from the DB.

  1. $shipment_item_id int The shipment item id.
add_action( "woocommerce_gzd_before_delete_shipment_item", function( $shipment_item_id ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_delete_shipment_item Action

Action that indicates that a ShipmentItem has been deleted from the DB.

  1. $shipment_item_id int The shipment item id.
  2. $item \Vendidero\Germanized\Shipments\ShipmentItem The shipment item object.
add_action( "woocommerce_gzd_delete_shipment_item", function( $shipment_item_id, $item ) {
    // Do something
        
}, 10, 2 );

woocommerce_gzd_shipment_item_object_updated_props Action

Action that fires after updating a ShipmentItem’s properties.

  1. $item \Vendidero\Germanized\Shipments\ShipmentItem The shipment item object.
  2. $changed_props array The updated properties.
add_action( "woocommerce_gzd_shipment_item_object_updated_props", function( $item, $changed_props ) {
    // Do something
        
}, 10, 2 );

woocommerce_gzd_packaging_class Filter

Filter to adjust the classname used to construct a Packaging.

  1. $classname string The classname to be used.
  2. $packaging_id int The packaging id.
add_filter( "woocommerce_gzd_packaging_class", function( $classname, $packaging_id ) {
    // Do something
    return $classname;    
}, 10, 2 );

woocommerce_gzd_shipping_method_rule_condition_operators Filter

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

woocommerce_gzd_shipping_method_rule_condition_types Filter

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

woocommerce_gzd_shipping_method_available_packaging_ids Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipping_method_available_packaging_ids", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipping_method_rule_condition_{$condition_type_name}_applies Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
  4. $param_4 string

woocommerce_gzd_shipping_method_rule_validate_{$validation_type} Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
  4. $param_4 string

woocommerce_gzd_shipping_provider_method_provider Filter

Filter that allows adjusting the shipping provider chosen for a specific shipping method.

  1. $provider_slug string The shipping provider.
  2. $method_id string The shipping method id.
  3. $method \Vendidero\Germanized\Shipments\ShippingMethod\ProviderMethod The method instance.
add_filter( "woocommerce_gzd_shipping_provider_method_provider", function( $provider_slug, $method_id, $method ) {
    // Do something
    return $provider_slug;    
}, 10, 3 );

woocommerce_gzd_shipping_provider_method_supports_instance_settings Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipping_provider_method_supports_instance_settings", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipments_disable_cart_packing Filter

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

woocommerce_gzd_shipments_get_methods_excluded_from_provider_settings Filter

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

woocommerce_gzd_shipments_shipping_method_is_excluded_from_provider_settings Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipments_shipping_method_is_excluded_from_provider_settings", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipping_provider_method_default_provider Filter

Filter to adjust default shipping provider pre-selected within shipping provider method settings.

  1. $provider_name string The shipping provider name e.g. dhl.
add_filter( "woocommerce_gzd_shipping_provider_method_default_provider", function( $provider_name ) {
    // Do something
    return $provider_name;    
}, 10, 1 );

woocommerce_gzd_shipping_provider_method_admin_settings Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipping_provider_method_admin_settings", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_item_synced Action

Action that fires after a shipment item has been synced. Syncing is used to keep the shipment item in sync with the corresponding order item or parent shipment item.

  1. $item \WC_Order_Item|\Vendidero\Germanized\Shipments\ShipmentItem The order item object or parent shipment item.
  2. $args array Array containing props in key => value pairs which have been updated.
  3. $param_3 string
add_action( "woocommerce_gzd_shipment_item_synced", function( $item, $args, $param_3 ) {
    // Do something
        
}, 10, 3 );

woocommerce_gzd_shipments_order_completed_status Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipments_order_completed_status", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_order_mark_as_completed Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipment_order_mark_as_completed", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipment_order_completed_status Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipment_order_completed_status", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_auto_create_shipments_for_order Filter

  1. $param_1 bool
  2. $param_2 string
  3. $param_3 string
add_filter( "woocommerce_gzd_auto_create_shipments_for_order", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_after_auto_create_shipments_for_order Action

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
  4. $param_4 string
add_action( "woocommerce_gzd_after_auto_create_shipments_for_order", function( $param_1, $param_2, $param_3, $param_4 ) {
    // Do something
        
}, 10, 4 );

woocommerce_gzd_shipments_bulk_action Filter

Filter to decide whether a Shipment has changed during bulk action or not.

  1. $changed bool Whether the Shipment has changed or not.
  2. $action string The bulk action
  3. $redirect_to string The redirect URL.
  4. $table \Vendidero\Germanized\Shipments\Admin\Table The table instance.
  5. $param_5 string
add_filter( "woocommerce_gzd_shipments_bulk_action", function( $changed, $action, $redirect_to, $table, $param_5 ) {
    // Do something
    return $changed;    
}, 10, 5 );

woocommerce_gzd_admin_shipment_date_format Filter

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

woocommerce_gzd_shipment_labels_bulk_filename Filter

Filter to adjust the default filename chosen for bulk exporting shipment labels.

  1. $filename string The filename.
  2. $this \Vendidero\Germanized\Shipments\Admin\BulkLabel The `BulkLabel instance.
add_filter( "woocommerce_gzd_shipment_labels_bulk_filename", function( $filename, $this ) {
    // Do something
    return $filename;    
}, 10, 2 );

woocommerce_gzd_shipments_product_options Action

  1. $param string
add_action( "woocommerce_gzd_shipments_product_options", function( $param ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipments_remove_legacy_customs_meta Filter

Remove legacy data upon saving in case it is not transmitted (e.g. DHL standalone plugin).

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_shipments_remove_legacy_customs_meta", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_shipments_save_product_options Action

  1. $param string
add_action( "woocommerce_gzd_shipments_save_product_options", function( $param ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_shipments_include_requested_return_count_in_menu Filter

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

woocommerce_gzd_shipments_meta_box_shipment_item_columns Filter

Filter to adjust shipment item columns shown in admin view.

  1. $item_columns array The columns available.
  2. $shipment \Vendidero\Germanized\Shipments\Shipment The shipment.
add_filter( "woocommerce_gzd_shipments_meta_box_shipment_item_columns", function( $item_columns, $shipment ) {
    // Do something
    return $item_columns;    
}, 10, 2 );

woocommerce_gzd_shipments_table_bulk_action_handlers Filter

Filter to register new BulkActionHandler for certain Shipment bulk actions.

  1. $handlers array Array containing key => classname.
add_filter( "woocommerce_gzd_shipments_table_bulk_action_handlers", function( $handlers ) {
    // Do something
    return $handlers;    
}, 10, 1 );

woocommerce_gzd_shipment_admin_provider_list Filter

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

woocommerce_gzd_shipment_label_admin_field_$postfix Action

  1. $param_1 string
  2. $param_2 string

woocommerce_gzd_shipments_packaging_report_default_shipment_types Filter

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

woocommerce_gzd_shipments_packaging_report_batch_size Filter

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

woocommerce_gzd_shipments_packaging_report_valid_statuses Filter

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

woocommerce_gzd_shipments_packer_instance Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
  4. $param_4 string
add_filter( "woocommerce_gzd_shipments_packer_instance", function( $param_1, $param_2, $param_3, $param_4 ) {
    // Do something
    return $param_1;    
}, 10, 4 );

woocommerce_gzd_shipments_packer_before_pack Action

  1. $param_1 string
  2. $param_2 string
add_action( "woocommerce_gzd_shipments_packer_before_pack", function( $param_1, $param_2 ) {
    // Do something
        
}, 10, 2 );

woocommerce_gzd_packaging_inner_dimension_use_percentage_buffer Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
add_filter( "woocommerce_gzd_packaging_inner_dimension_use_percentage_buffer", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_packaging_inner_dimension_percentage_buffer Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
add_filter( "woocommerce_gzd_packaging_inner_dimension_percentage_buffer", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_packaging_inner_dimension_fixed_buffer_mm Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
add_filter( "woocommerce_gzd_packaging_inner_dimension_fixed_buffer_mm", function( $param_1, $param_2, $param_3 ) {
    // Do something
    return $param_1;    
}, 10, 3 );

woocommerce_gzd_shipments_item_fits_packaging Filter

  1. $param_1 string
  2. $param_2 string
  3. $param_3 string
  4. $param_4 string
  5. $param_5 string
add_filter( "woocommerce_gzd_shipments_item_fits_packaging", function( $param_1, $param_2, $param_3, $param_4, $param_5 ) {
    // Do something
    return $param_1;    
}, 10, 5 );

woocommerce_gzd_packing_item_keep_flat Filter

  1. $param_1 bool
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_keep_flat", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_description Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_description", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_width_in_mm Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_width_in_mm", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_length_in_mm Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_length_in_mm", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_depth_in_mm Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_depth_in_mm", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_weight_in_g Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_weight_in_g", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );

woocommerce_gzd_packing_item_total_in_cents Filter

  1. $param_1 string
  2. $param_2 string
add_filter( "woocommerce_gzd_packing_item_total_in_cents", function( $param_1, $param_2 ) {
    // Do something
    return $param_1;    
}, 10, 2 );