• Germanized
  • Hooks

DHL

Hooks for the DHL package bundled in Germanized.

woocommerce_gzd_dhl_enabled Filter

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

woocommerce_gzd_dhl_holidays Filter

Filter to adjust dates regarded as holidays for a certain country.

  1. $holidays array Array containing dates in Y-m-d format.
  2. $country string The country as ISO code.
add_filter( "woocommerce_gzd_dhl_holidays", function( $holidays, $country ) {
    // Do something
    return $holidays;    
}, 10, 2 );

woocommerce_gzd_dhl_get_i18n_path Filter

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

woocommerce_gzd_dhl_get_i18n_textdomain Filter

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

woocommerce_gzd_dhl_use_legacy_soap_api Filter

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

woocommerce_gzd_dhl_retoure_receiver Filter

Returns the DHL retoure receiver id for a certain country.

  1. $receiver array The receiver to be used for the retoure.
  2. $country string The country code of the retoure.
add_filter( "woocommerce_gzd_dhl_retoure_receiver", function( $receiver, $country ) {
    // Do something
    return $receiver;    
}, 10, 2 );

woocommerce_gzd_dhl_upload_dir Filter

Filter to adjust the DHL label upload directory. By default DHL labels are stored in a custom directory under wp-content/uploads.

  1. $upload_dir array Array containing `wp_upload_dir` data.
add_filter( "woocommerce_gzd_dhl_upload_dir", function( $upload_dir ) {
    // Do something
    return $upload_dir;    
}, 10, 1 );

woocommerce_gzd_dhl_relative_upload_dir Filter

Filter to retrieve the DHL label relative upload path.

  1. $path array Relative path.
add_filter( "woocommerce_gzd_dhl_relative_upload_dir", function( $path ) {
    // Do something
    return $path;    
}, 10, 1 );

woocommerce_gzd_dhl_alternate_wsdl_file Filter

This filter may be used to force loading an alternate (local) WSDL file for a certain API endpoint. By default we are trying to locally store necessary files to reduce API calls. Transients/files are renewed once per day.

  1. $alternate_file bool|string In case an alternate file should be used this must be the absolute path.
  2. $wsdl_link string The link to the original WSDL file.
add_filter( "woocommerce_gzd_dhl_alternate_wsdl_file", function( $alternate_file, $wsdl_link ) {
    // Do something
    return $alternate_file;    
}, 10, 2 );

woocommerce_gzd_dhl_upload_path Filter

Filter to adjust the DHL label upload path. By default DHL labels are stored in a custom directory under wp-content/uploads.

  1. $path string Path to the upload directory.
add_filter( "woocommerce_gzd_dhl_upload_path", function( $path ) {
    // Do something
    return $path;    
}, 10, 1 );

woocommerce_gzd_dhl_upload_url Filter

Filter to adjust the DHL label upload URL. By default DHL labels are stored in a custom directory under wp-content/uploads.

  1. $url string URL to the upload directory.
add_filter( "woocommerce_gzd_dhl_upload_url", function( $url ) {
    // Do something
    return $url;    
}, 10, 1 );

woocommerce_gzd_dhl_enable_logging Filter

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

woocommerce_gzd_dhl_base_country Filter

Filter to adjust the DHL base country.

  1. $country string The country as ISO code.
add_filter( "woocommerce_gzd_dhl_base_country", function( $country ) {
    // Do something
    return $country;    
}, 10, 1 );

woocommerce_gzd_dhl_label_api_insurance_amount Filter

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

woocommerce_gzd_dhl_label_api_shipper_reference Filter

This filter allows using a ShipperReference configured in the GKP instead of transmitting the shipper data from the DHL settings. Use this filter carefully and make sure that the reference exists.

  1. $shipper_reference string The shipper reference from the GKP.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_shipper_reference", function( $shipper_reference, $label ) {
    // Do something
    return $shipper_reference;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_shipper_name1 Filter

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

woocommerce_gzd_dhl_label_api_shipper_name2 Filter

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

woocommerce_gzd_dhl_label_api_shipper_name3 Filter

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

woocommerce_gzd_dhl_label_api_shipper_street Filter

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

woocommerce_gzd_dhl_label_api_shipper_zip Filter

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

woocommerce_gzd_dhl_label_api_shipper_city Filter

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

woocommerce_gzd_dhl_label_api_shipper_email Filter

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

woocommerce_gzd_dhl_label_api_shipper_country Filter

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

woocommerce_gzd_dhl_label_api_receiver_name3 Filter

By default the name3 parameter is used to transmit the additional address field to the DHL API. You may adjust the field value by using this filter.

  1. $value string The field value.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_receiver_name3", function( $value, $label ) {
    // Do something
    return $value;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_communication_contact_person Filter

Choose whether to transmit the full name of the shipment receiver as contactPerson while creating a label.

  1. $name string The name of the shipmen receiver.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_communication_contact_person", function( $name, $label ) {
    // Do something
    return $name;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_communication_phone Filter

Choose whether to transfer the phone number to DHL on creating a label. By default the phone number is not transmitted.

  1. $phone string The phone number.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_communication_phone", function( $phone, $label ) {
    // Do something
    return $phone;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_communication_email Filter

Choose whether to transfer the email to DHL on creating a label. By default the email is only transmitted if the customer opted in. This email address is not used to notify the customer via DHL. It is only meant for communicaton purposes.

  1. $email string The email.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_communication_email", function( $email, $label ) {
    // Do something
    return $email;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_export_invoice_number Filter

Filter to allow adjusting the export invoice number.

  1. $invoice_number string The invoice number.
  2. $label \Vendidero\Germanized\DHL\Label\Label The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_export_invoice_number", function( $invoice_number, $label ) {
    // Do something
    return $invoice_number;    
}, 10, 2 );

woocommerce_gzd_dhl_label_rest_api_customs_data Filter

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

woocommerce_gzd_dhl_label_rest_api_create_label_request Filter

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

woocommerce_gzd_dhl_label_api_export_type Filter

Filter to allow adjusting the export type of a DHL label (for customs). Could be:

  • OTHER
  • PRESENT
  • COMMERCIAL_SAMPLE
  • DOCUMENT
  • RETURN_OF_GOODS
  • COMMERCIAL_GOODS

  1. $export_type string The export type.
  2. $label \Vendidero\Germanized\DHL\Label\Label The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_export_type", function( $export_type, $label ) {
    // Do something
    return $export_type;    
}, 10, 2 );

woocommerce_gzd_dhl_return_label_api_sender_name3 Filter

By default the name3 parameter is used to transmit the additional address field to the DHL API. You may adjust the field value by using this filter.

  1. $value string The field value.
  2. $label \Vendidero\Germanized\DHL\Label\ReturnLabel The label instance.
add_filter( "woocommerce_gzd_dhl_return_label_api_sender_name3", function( $value, $label ) {
    // Do something
    return $value;    
}, 10, 2 );

woocommerce_gzd_dhl_retoure_customs_data Filter

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

woocommerce_gzd_dhl_label_api_deleted Action

Action fires after deleting a DHL PDF label through an API call.

  1. $label \Vendidero\Germanized\DHL\Label\DHL The label object.
add_action( "woocommerce_gzd_dhl_label_api_deleted", function( $label ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_dhl_label_api_province Filter

The province field actually prints the state on the DHL label.

  1. $value string The field value.
  2. $label \Vendidero\Germanized\DHL\Label\DHL The label instance.
add_filter( "woocommerce_gzd_dhl_label_api_province", function( $value, $label ) {
    // Do something
    return $value;    
}, 10, 2 );

woocommerce_gzd_dhl_label_api_shipper_street_number Filter

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

woocommerce_gzd_dhl_label_api_shipper_street_name Filter

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

woocommerce_gzd_dhl_label_api_shipper_phone Filter

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

woocommerce_gzd_dhl_label_api_shipper_state Filter

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

woocommerce_gzd_dhl_label_api_customs_data Filter

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

woocommerce_gzd_dhl_label_api_create_label_request Filter

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

woocommerce_gzd_dhl_consider_saturday_as_working_day Filter

Filter to decide whether DHL should consider saturday as a working day for preferred day calculation or not.

  1. $is_working_day bool True if saturday should be considered a working day.
add_filter( "woocommerce_gzd_dhl_consider_saturday_as_working_day", function( $is_working_day ) {
    // Do something
    return $is_working_day;    
}, 10, 1 );

woocommerce_gzd_deutsche_post_exclude_page_format Filter

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

woocommerce_gzd_dhl_deutsche_post_label_api_before_delete Action

Action fires before deleting a Deutsche Post PDF label through an API call.

  1. $label \Vendidero\Germanized\DHL\Label\DeutschePost The label object.
add_action( "woocommerce_gzd_dhl_deutsche_post_label_api_before_delete", function( $label ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_dhl_deutsche_post_label_api_deleted Action

Action fires after deleting a Deutsche Post PDF label through an API call.

  1. $label \Vendidero\Germanized\DHL\Label\DeutschePost The label object.
add_action( "woocommerce_gzd_dhl_deutsche_post_label_api_deleted", function( $label ) {
    // Do something
        
}, 10, 1 );

woocommerce_gzd_deutsche_post_label_api_position_x Filter

Adjust the Deutsche Post (Internetmarke) label print X position.

  1. $x mixed The x axis position.
  2. $label \Vendidero\Germanized\DHL\Label\DeutschePost The label instance.
  3. $shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.
add_filter( "woocommerce_gzd_deutsche_post_label_api_position_x", function( $x, $label, $shipment ) {
    // Do something
    return $x;    
}, 10, 3 );

woocommerce_gzd_deutsche_post_label_api_position_y Filter

Adjust the Deutsche Post (Internetmarke) label print Y position.

  1. $y mixed The y axis position.
  2. $label \Vendidero\Germanized\DHL\Label\DeutschePost The label instance.
  3. $shipment \Vendidero\Germanized\Shipments\Shipment The shipment instance.
add_filter( "woocommerce_gzd_deutsche_post_label_api_position_y", function( $y, $label, $shipment ) {
    // Do something
    return $y;    
}, 10, 3 );

woocommerce_gzd_deutsche_post_label_api_page_number Filter

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

woocommerce_gzd_deutsche_post_label_api_customs_shipment_service_level Filter

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

woocommerce_gzd_deutsche_post_label_api_customs_shipment_nature_type Filter

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

Login