WooCommerce Code Reference

CanadaPostShippingProvider extends AbstractShippingProvider
in package

Canada Post Shipping Provider class.

Provides Canada Post tracking number validation, supported countries, and tracking URL generation.

Table of Contents

TRACKING_PATTERNS  = array('CA' => array( // Canada. 'patterns' => array( // UPU S10 international format (outbound). '/^[A-Z]{2}\d{9}CA$/', // Standard format: XX#########CA. // UPU S10 international (inbound/other countries, fallback). '/^[A-Z]{2}\d{9}[A-Z]{2}$/', // Any S10/UPU code. // Domestic numeric formats. '/^\d{16}$/', // 16-digit domestic tracking. '/^\d{15}$/', // 15-digit legacy/partner/returns. '/^\d{14}$/', // 14-digit legacy/partner/returns. '/^\d{13}$/', // 13-digit domestic (most common). '/^\d{12}$/', // 12-digit domestic. '/^\d{10}$/', // 10-digit legacy. '/^\d{9}$/', // 9-digit legacy. '/^\d{8}$/', // 8-digit calling card/legacy. // Service-specific patterns. '/^XP\d{9}CA$/', // Xpresspost International. '/^EX\d{9}CA$/', // Express International. '/^PR\d{9}CA$/', // Priority. '/^RG\d{9}CA$/', // Regular (deprecated, legacy). '/^RM\d{9}CA$/', // Registered Mail. '/^CM\d{9}CA$/', // Certified Mail. '/^[A-Z]{2}\d{7}[A-Z]{2}$/', // International format: XX#######XX. '/^[A-Z]{1}\d{9}[A-Z]{1}$/', // Domestic formats: X#########X. '/^FD\d{10,12}$/', // FlexDelivery. '/^PO\d{10,12}$/', // Post Office Box service. '/^CP\d{10,14}$/', // Canada Post business. '/^SM\d{10,14}$/', // Small packet. // Legacy and alternative formats. '/^[0-9]{13}[A-Z]{1}$/', ), 'confidence' => 92, ))
Canada Post tracking number patterns with service differentiation.
can_ship_from()  : bool
Check if the shipping provider can ship from a specific country.
can_ship_from_to()  : bool
Check if the shipping provider can ship from a specific country to another.
can_ship_to()  : bool
Check if the shipping provider can ship to a specific country.
get_icon()  : string
Get the icon URL for this shipping provider.
get_key()  : string
Get the unique key for this shipping provider.
get_name()  : string
Get the name of this shipping provider.
get_shipping_from_countries()  : array<string|int, mixed>
Get the countries this shipping provider can ship from.
get_shipping_to_countries()  : array<string|int, mixed>
Get the countries this shipping provider can ship to.
get_tracking_url()  : string
Get the tracking URL for a given tracking number.
try_parse_tracking_number()  : array<string|int, mixed>|null
Try to parse a Canada Post tracking number.
validate_country_pattern()  : bool
Validate tracking number against country-specific patterns.

Constants

TRACKING_PATTERNS

Canada Post tracking number patterns with service differentiation.

private array<string, array{patterns: array, confidence: int}> TRACKING_PATTERNS = array('CA' => array( // Canada. 'patterns' => array( // UPU S10 international format (outbound). '/^[A-Z]{2}\d{9}CA$/', // Standard format: XX#########CA. // UPU S10 international (inbound/other countries, fallback). '/^[A-Z]{2}\d{9}[A-Z]{2}$/', // Any S10/UPU code. // Domestic numeric formats. '/^\d{16}$/', // 16-digit domestic tracking. '/^\d{15}$/', // 15-digit legacy/partner/returns. '/^\d{14}$/', // 14-digit legacy/partner/returns. '/^\d{13}$/', // 13-digit domestic (most common). '/^\d{12}$/', // 12-digit domestic. '/^\d{10}$/', // 10-digit legacy. '/^\d{9}$/', // 9-digit legacy. '/^\d{8}$/', // 8-digit calling card/legacy. // Service-specific patterns. '/^XP\d{9}CA$/', // Xpresspost International. '/^EX\d{9}CA$/', // Express International. '/^PR\d{9}CA$/', // Priority. '/^RG\d{9}CA$/', // Regular (deprecated, legacy). '/^RM\d{9}CA$/', // Registered Mail. '/^CM\d{9}CA$/', // Certified Mail. '/^[A-Z]{2}\d{7}[A-Z]{2}$/', // International format: XX#######XX. '/^[A-Z]{1}\d{9}[A-Z]{1}$/', // Domestic formats: X#########X. '/^FD\d{10,12}$/', // FlexDelivery. '/^PO\d{10,12}$/', // Post Office Box service. '/^CP\d{10,14}$/', // Canada Post business. '/^SM\d{10,14}$/', // Small packet. // Legacy and alternative formats. '/^[0-9]{13}[A-Z]{1}$/', ), 'confidence' => 92, ))

Methods

can_ship_from()

Check if the shipping provider can ship from a specific country.

public can_ship_from(string $country_code) : bool
Parameters
$country_code : string

The country code to check.

Return values
bool — True if the provider can ship from the country, false otherwise.

can_ship_from_to()

Check if the shipping provider can ship from a specific country to another.

public can_ship_from_to(string $shipping_from, string $shipping_to) : bool
Parameters
$shipping_from : string

The country code from which the shipment is sent.

$shipping_to : string

The country code to which the shipment is sent.

Return values
bool — True if the provider can ship from the source to the destination, false otherwise.

can_ship_to()

Check if the shipping provider can ship to a specific country.

public can_ship_to(string $country_code) : bool
Parameters
$country_code : string

The country code to check.

Return values
bool — True if the provider can ship to the country, false otherwise.

try_parse_tracking_number()

Try to parse a Canada Post tracking number.

public try_parse_tracking_number(string $tracking_number, string $shipping_from, string $shipping_to) : array<string|int, mixed>|null
Parameters
$tracking_number : string

The tracking number to parse.

$shipping_from : string

The country code of the shipping origin.

$shipping_to : string

The country code of the shipping destination.

Return values
array<string|int, mixed>|null — An array with 'url' and 'ambiguity_score' if valid, null otherwise.

validate_country_pattern()

Validate tracking number against country-specific patterns.

private validate_country_pattern(string $tracking_number, string $country_code) : bool
Parameters
$tracking_number : string

The tracking number to validate.

$country_code : string

The country code for the shipment.

Return values
bool — True if valid, false otherwise.