WC_Cart::get_shipping_package_name │ private │ WC 1.0

Get the package name.

Method of the class: WC_Cart{}

Returns

String.

Usage

// private - for code of main (parent) class only
$result = $this->get_shipping_package_name( $package, $index, $total_packages );

$package(array) (required)

Shipping package data.

$index(int) (required)

Package number.

$total_packages(int) (required)

Total number of packages.

WC_Cart::get_shipping_package_name() WC Cart::get shipping package name code ^{WC 10.7.0}

private function get_shipping_package_name( $package, $index, $total_packages ) {

	$shipping_package_name = _x( 'Shipment', 'shipping packages', 'woocommerce' );

	/**
	 * If there are multiple packages, use the index to show the package number.
	 */
	if ( 1 !== $total_packages ) {
		$shipping_package_name = sprintf(
			/* translators: %d: shipping package number. */
			_x( 'Shipment %d', 'shipping packages', 'woocommerce' ),
			$index
		);
	}

	/**
	 * Filters the shipping package name.
	 *
	 * @since 4.3.0
	 * @param string $shipping_package_name Shipping package name.
	 * @param string $package_id Shipping package ID.
	 * @param array $package Shipping package from WooCommerce.
	 * @param int $total_packages Total number of shipping packages.
	 * @return string Shipping package name.
	 */
	return apply_filters(
		'woocommerce_shipping_package_name',
		$shipping_package_name,
		$package['package_id'],
		$package,
		$total_packages
	);
}