�PNG  IHDR22?�� pHYs  �� OiCCPPhotoshop ICC profilexڝSgTS�=���BK���KoR RB���&*! J�!��Q�EEȠ�����Q, � ��!���������{�kּ������>���� �H3Q5� �B�������.@� $p�d!s�#�~<<+"��x� �M��0���B�\���t�8K�@z�B�@F���&S�`�cb�P-`'������{[�!�� e�Dh;��V�EX0fK�9�-0IWfH���� � 0Q��){`�##x��F�W<�+��*x��<�$9E�[-qWW.(�I+6aa�@.�y�2�4���������x����6��_-��"bb���ϫp@�t~��,/��;�m��%�h^ �u��f�@����W�p�~<�5�j>{�-�]c�K'Xt����o��(�h���w��?�G�%�fI�q^D$.Tʳ?�D��*�A��,���� �`6�B$��BB d�r`)��B(�Ͱ*`/�@4�Qh��p.�U�=p�a��(�� A�a!ڈb�X#����!�H�$ ɈQ"K�5H1R�T UH�=r9�\F��;�2����G1���Q=� �C��7�F� �dt1�����r�=�6��Ыhڏ>C�0��3�l0.��B�8, �c˱"� ���V����cϱw�E� 6wB aAHXLXN�H� $4� 7 �Q�'"��K�&���b21�XH,#��/{�C�7$�C2'��I��T��F�nR#�,��4H#���dk�9�, +ȅ����3��!�[ �b@q��S�(R�jJ��4�e�2AU��Rݨ�T5�ZB���R�Q��4u�9̓IK�����hh�i��t�ݕN��W���G���w ��Ljg(�gw��L�Ӌ�T071���oUX*�*|�� �J�&�*/T����ު U�U�T��^S}�FU3S� Ԗ�U��P�SSg�;���g�oT?�~Y��Y�L�OC�Q��_�� c�x,!k ��u�5�&���|v*�����=���9C3J3W�R�f?�q��tN �(���~���)�)�4L�1e\k����X�H�Q�G�6������E�Y��A�J'\'Gg����S�Sݧ �M=:��.�k���Dw�n��^��Lo��y���}/�T�m���G X� $� �<�5qo</���QC]�@C�a�a�ᄑ��<��F�F�i�\�$�m�mƣ&&!&KM�M�RM��)�;L;L���͢�֙5�=1�2��כ߷`ZxZ,����eI��Z�Yn�Z9Y�XUZ]�F���%ֻ�����N�N���gð�ɶ�����ۮ�m�}agbg�Ů��}�}��= ���Z~s�r:V:ޚΜ�?}����/gX���3��)�i�S��Ggg�s�󈋉K��.�>.���Ƚ�Jt�q]�z���������ۯ�6�i�ܟ�4�)�Y3s���C�Q��? ��0k߬~OCO�g��#/c/�W�װ��w��a�>�>r��>�<7�2�Y_�7��ȷ�O�o�_��C#�d�z����%g��A�[��z|!��?:�e����A���AA�������!h�쐭!��Α�i�P~���a�a��~ '���W�?�p�X�1�5w��Cs�D�D�Dޛg1O9�-J5*>�.j<�7�4�?�.fY��X�XIlK9.*�6nl������� �{�/�]py�����.,:�@L�N8��A*��%�w%� y��g"/�6ш�C\*N�H*Mz�쑼5y$�3�,幄'���L Lݛ:��v m2=:�1����qB�!M��g�g�fvˬe����n��/��k���Y- �B��TZ(�*�geWf�͉�9���+��̳�ې7�����ᒶ��KW-X潬j9�������(�x��oʿ�ܔ���Ĺd�f�f���-�[����n �ڴ �V����E�/��(ۻ��C���<��e����;?T�T�T�T6��ݵa��n��{��4���[���>ɾ�UUM�f�e�I���?�������m]�Nmq����#�׹���=TR��+�G�����w- 6 U����#pDy��� �� :�v�{���vg/jB��F�S��[b[�O�>����z�G��499�?r����C�d�&����ˮ/~�����јѡ�򗓿m|������������x31^�V���w�w��O�| (�h���SЧ��������c3-� cHRMz%������u0�`:�o�_�F5IDATx��ytUս�?�;���fN$$��@B�!�k��� -*�gE���j�O�kQ�ʠ`U�B_ �AÐ0%�Ȕ�@r3ޛ;߳��$�@��v����^�s����������$��ߢ !�W��5�̱'-٘������4�>�Rƫ$�G��0U�H}�_ _� #��k�MJ/=�9Du *ڲ�k�PQ;0��j|�*�$�^컂脛y���>�z×� B��� ��(�:$�ʔ_�6��C!B����MVx��a��ζyY����j��ƋY2�9�F�{r��r�딟F��Q��hY6��� x��[l��RC��������nt@��;P��3��� F�w��7��:�P���ɋ'���mj���Bƪ�$�Q�L��y��߷g��\���z����v5�p�v$�v櫻�`6~K �Y�X����,�:��"�o�e0II"(��,������l_�C���/4�+f�E�!q��:����u����c��樼.UE�@� �]K�W���$-�h]�JG���Dz)�`��.�A/ ���mᏣc�3jK� �!�>���$�Q�!�_�? \�C2(E �M$Z I{�U���s�ǣ���=��@Բe ޻��W�����@ �w����}�9v,)��.}*|"�s��di���,���G�]W�AC�������|<����[��ߕ������K�*�G nߴ!��‹��J�!��6(L�a)��Am��������;adf��:�xm��nh�;֦I��(���o�C~ډa?�=��s����h��E������xp����)���_���t��W�����´;8���`dz=(��@@�+,�;�`�fhl��XȌ�3,uI�~z(J����� �ZX�A����H'�À�㜦�82|��a�n�z2��I���� ���EY�h�ε<�0�q�{��C��v�˅��?"@��χ�x�WS+��N�~�KQ�J�8ل�� _.W��� !TU{�����,��"�� �;�������HI S� ��))�o�1�H�D� ���� (� ;����"Ҕ��,���� �F=���O��&�Ph>�`���y��߲ &S��P�<��'��1s�1cĂ�N����2)����@�u��tv��<�+�-&�����h��[!FSG���' � z z0��<����8d&�����E0�,��<��"!P�b4��� �{S�����X����.�囤���T��hEF��X�q0"-<����h���]�Py*����F⩍��@v�˂�Y08�� .q��a��s����(!<̫1�3�L�H��7sYW�`��qtu�\7��?�@�Y�� %Ka�x�GZ�*W�P��y�����N0r9��Z�c�%���q,��k�����!!,��>���IB��� �x1�Xu�Y���v-���ֺ��N������JP��a�2`�e5��w��u;�6�i���̃��(K���ťa��(l51��JL��O'%���]���ٖ뿉!��{*�p+f ���i8��D�ȑ���ܩ�M��V��ӟz��x�7Z�1i}�^͜���6e����x��)u�d�ˏ�V�eG�\�X1�����=n�U'�~Y����L�\,�(d!x ,�:�TW8� M`r���@��r+v�Q0��>^;˴�VbF��('����� �*O��i��j�Ӆ����^�S3&� ���{������.ی�� N;��NU%d0�Ce\r"�C�b��&t7N�7��� �ȪD�[%l�۪�$��'m?�A9tI�9>��NVL ��� 6v~M�����ъ�B���0����9$&=ώm��W�0���L���&��E���f�f��'+�9��hv��7,���M��6�D�&�^� �����8 D֮�����o��k^z��O��hP�8q�5d*��YVq3�{��������#LX4�?��jP=3�~�؅c�ݰ�̱�ұ��8̲��2�G�����j��έ�9��w7���U�X�w�85C��?!I&���o&����L���I#�^�eV�,�^t5�k� �xs˛\��U�8��."���{���ǵ�l4��ݼ�;��r"���G�/~���gJV�N糦��ZZ^k+NN�D��I$�=OE�z����|*�*{��%k���G��>�`9��b;�s���8,�qs��c��.b��q�%�>r��n�R�Ƨ�%�,�A��le#�8���}; 21�0�b�&�QX�f���q�00����$>�h�N�'�a3��A���/�r ��L5�8�GԲ'�����w;��c#�q1���h$*��V^�k��QĽ�b:i������� ����H F#�_���,��]g����Ը����`RUU���� ��"�qD���>-��ϤI�~��3�̴�����NZ[[555�eeek7�m����YF#[��Đ��R��i��L�H�r ��@��J-�Pŝ��_|�-��6y��ks�V�U~��6���w.����(��0A� 4��f��� /���C�xŊ�ٳ����z=6�����rg���mKo��o�/����a�g���?'9%9��P��斓��~���L{�� �H��{AW��B��$����v�1b�&Mb�ر��ر#�0`�`xMBp! )Z�Nmo�mZ�g�}�eذaWTVV ���'99��C5��&�&+5�bT>|8��PUUETT����&���t��~TE%��'������b�tEGG;RSS�S�N�v��ѯ��t����u1@�ޚ"f��͈���r'L�Ph��m��ƌ�74o��`�x�q�P���NRSS�X,�����l&&&��MFFA!-��`��ҷ�n��Yuu�����x<I�LB%����KԒ50�!�3�bz�����ʸKL���;---�l6[��`��������Ȏ;�����egg4��!D�T��jWujyZ��������K����%����p�^���X,6��sV=�ܖ����6�3�X ���4ҿ��A2�&����_k�;d�� �VfOIEND�B`� 0x0x
0x0x
PHP 8.1.34
Preview: class-wc-order-item.php Size: 22.70 KB
/home2/astrociv/www/rudraraksham.com/wp-content/plugins/woocommerce/includes/class-wc-order-item.php
<?php
/**
 * Order Item
 *
 * A class which represents an item within an order and handles CRUD.
 * Uses ArrayAccess to be BW compatible with WC_Orders::get_items().
 *
 * @package WooCommerce\Classes
 * @version 3.0.0
 * @since   3.0.0
 */

use Automattic\WooCommerce\Enums\ProductTaxStatus;
use Automattic\WooCommerce\Enums\ProductType;
use Automattic\WooCommerce\Internal\CostOfGoodsSold\CogsAwareTrait;

defined( 'ABSPATH' ) || exit;

/**
 * Order item class.
 */
class WC_Order_Item extends WC_Data implements ArrayAccess {
	use CogsAwareTrait;

	/**
	 * Legacy cart item values.
	 *
	 * @deprecated 4.4.0 For legacy actions.
	 * @var array
	 */
	public $legacy_values;

	/**
	 * Legacy cart item keys.
	 *
	 * @deprecated 4.4.0 For legacy actions.
	 * @var string
	 */
	public $legacy_cart_item_key;

	/**
	 * Order Data array. This is the core order data exposed in APIs since 3.0.0.
	 *
	 * @since 3.0.0
	 * @var array
	 */
	protected $data = array(
		'order_id' => 0,
		'name'     => '',
	);

	/**
	 * Stores meta in cache for future reads.
	 * A group must be set to to enable caching.
	 *
	 * @var string
	 */
	protected $cache_group = 'order-items';

	/**
	 * Meta type. This should match up with
	 * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
	 * WP defines 'post', 'user', 'comment', and 'term'.
	 *
	 * @var string
	 */
	protected $meta_type = 'order_item';

	/**
	 * This is the name of this object type.
	 *
	 * @var string
	 */
	protected $object_type = 'order_item';

	/**
	 * Legacy package key.
	 *
	 * @deprecated 4.4.0 For legacy actions.
	 * @var string
	 */
	public $legacy_package_key;

	/**
	 * The order object is set using set_order. This property was introduced to reduce the number
	 * of wc_get_order calls when working with this class in core and extension workflows.
	 * Stored as a WeakReference to avoid circular reference memory retention in batch/CLI workflows.
	 *
	 * @var null|\WeakReference<\WC_Order>
	 */
	private $order;

	/**
	 * Constructor.
	 *
	 * @param int|object|array $item ID to load from the DB, or WC_Order_Item object.
	 */
	public function __construct( $item = 0 ) {
		if ( $this->has_cogs() && $this->cogs_is_enabled() ) {
			$this->data['cogs_value'] = null;
		}

		parent::__construct( $item );

		if ( $item instanceof WC_Order_Item ) {
			$this->set_id( $item->get_id() );
		} elseif ( is_numeric( $item ) && $item > 0 ) {
			$this->set_id( $item );
		} else {
			$this->set_object_read( true );
		}

		if ( $this->get_id() && __CLASS__ === get_class( $this ) ) {
			wc_doing_it_wrong( __METHOD__, 'WC_Order_Item should not be instantiated directly.', '9.9.0' );
			return;
		}

		$type             = 'line_item' === $this->get_type() ? 'product' : $this->get_type();
		$this->data_store = WC_Data_Store::load( 'order-item-' . $type );
		if ( $this->get_id() > 0 ) {
			$this->data_store->read( $this );
		}
	}

	/**
	 * Merge changes with data and clear.
	 * Overrides WC_Data::apply_changes.
	 * array_replace_recursive does not work well for order items because it merges taxes instead
	 * of replacing them.
	 *
	 * @since 3.2.0
	 */
	public function apply_changes() {
		$this->data    = array_replace( $this->data, $this->changes );
		$this->changes = array();
	}

	/*
	|--------------------------------------------------------------------------
	| Getters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Get order ID this meta belongs to.
	 *
	 * @param  string $context What the value is for. Valid values are 'view' and 'edit'.
	 * @return int
	 */
	public function get_order_id( $context = 'view' ) {
		return $this->get_prop( 'order_id', $context );
	}

	/**
	 * Get order item name.
	 *
	 * @param  string $context What the value is for. Valid values are 'view' and 'edit'.
	 * @return string
	 */
	public function get_name( $context = 'view' ) {
		return $this->get_prop( 'name', $context );
	}

	/**
	 * Get order item type. Overridden by child classes.
	 *
	 * @return string
	 */
	public function get_type() {
		return '';
	}

	/**
	 * Get quantity.
	 *
	 * @return int
	 */
	public function get_quantity() {
		return 1;
	}

	/**
	 * Get tax status.
	 *
	 * @return string
	 */
	public function get_tax_status() {
		return ProductTaxStatus::TAXABLE;
	}

	/**
	 * Get tax class.
	 *
	 * @return string
	 */
	public function get_tax_class() {
		return '';
	}

	/**
	 * Get parent order object.
	 *
	 * @since 10.9.0 returns the same order instance associated with the item; previously, a new instance was created on each call.
	 * @return WC_Order
	 */
	public function get_order() {
		$order = $this->order ? $this->order->get() : null;
		return $order ?? wc_get_order( $this->get_order_id() );
	}

	/*
	|--------------------------------------------------------------------------
	| Setters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Set order ID.
	 *
	 * @param int $value Order ID.
	 */
	public function set_order_id( $value ) {
		$order_id = absint( $value );
		$this->set_prop( 'order_id', $order_id );

		$order = $this->order ? $this->order->get() : null;
		if ( null !== $order && $order->get_id() !== $order_id ) {
			$this->order = null;
		}
	}

	/**
	 * Aggregate and set properties based on passed in order object.
	 *
	 * @since 10.9.0
	 * @param WC_Abstract_Order $order Order instance.
	 * @return void
	 */
	public function set_order( $order ) {
		if ( ! ( $order instanceof \WC_Abstract_Order ) ) {
			$this->error( 'order_item_invalid_order', __( 'Invalid order', 'woocommerce' ) );
		}
		$this->set_order_id( $order->get_id() );
		// Don't inject the refund object: get_order() declares a WC_Order return type; WC_Order_Refund would violate that contract.
		if ( $order instanceof \WC_Order ) {
			$this->order = \WeakReference::create( $order );
		}
	}

	/**
	 * Set order item name.
	 *
	 * @param string $value Item name.
	 */
	public function set_name( $value ) {
		$this->set_prop( 'name', wp_check_invalid_utf8( $value ) );
	}

	/*
	|--------------------------------------------------------------------------
	| Other Methods
	|--------------------------------------------------------------------------
	*/

	/**
	 * Type checking.
	 *
	 * @param  string|array $type Type.
	 * @return boolean
	 */
	public function is_type( $type ) {
		return is_array( $type ) ? in_array( $this->get_type(), $type, true ) : $type === $this->get_type();
	}

	/**
	 * Calculate item taxes.
	 *
	 * @since  3.2.0
	 * @param  array $calculate_tax_for Location data to get taxes for. Required.
	 * @return bool  True if taxes were calculated.
	 */
	public function calculate_taxes( $calculate_tax_for = array() ) {
		if ( ! isset( $calculate_tax_for['country'], $calculate_tax_for['state'], $calculate_tax_for['postcode'], $calculate_tax_for['city'] ) ) {
			return false;
		}
		if ( '0' !== $this->get_tax_class() && ProductTaxStatus::TAXABLE === $this->get_tax_status() && wc_tax_enabled() ) {
			$calculate_tax_for['tax_class'] = $this->get_tax_class();
			$tax_rates                      = WC_Tax::find_rates( $calculate_tax_for );
			$taxes                          = WC_Tax::calc_tax( $this->get_total(), $tax_rates, false );

			if ( method_exists( $this, 'get_subtotal' ) ) {
				$subtotal_taxes = WC_Tax::calc_tax( $this->get_subtotal(), $tax_rates, false );
				$this->set_taxes(
					array(
						'total'    => $taxes,
						'subtotal' => $subtotal_taxes,
					)
				);
			} else {
				$this->set_taxes( array( 'total' => $taxes ) );
			}
		} else {
			$this->set_taxes( false );
		}

		do_action( 'woocommerce_order_item_after_calculate_taxes', $this, $calculate_tax_for );

		return true;
	}

	/*
	|--------------------------------------------------------------------------
	| Meta Data Handling
	|--------------------------------------------------------------------------
	*/

	/**
	 * Wrapper for get_formatted_meta_data that includes all metadata by default. See https://github.com/woocommerce/woocommerce/pull/30948
	 *
	 * @param string $hideprefix  Meta data prefix, (default: _).
	 * @param bool   $include_all Include all meta data, this stop skip items with values already in the product name.
	 * @return array
	 */
	public function get_all_formatted_meta_data( $hideprefix = '_', $include_all = true ) {
		return $this->get_formatted_meta_data( $hideprefix, $include_all );
	}

	/**
	 * Expands things like term slugs before return.
	 *
	 * @param string $hideprefix  Meta data prefix, (default: _).
	 * @param bool   $include_all Include all meta data, this stop skip items with values already in the product name.
	 * @return array
	 */
	public function get_formatted_meta_data( $hideprefix = '_', $include_all = false ) {
		$formatted_meta    = array();
		$meta_data         = $this->get_meta_data();
		$hideprefix_length = ! empty( $hideprefix ) ? strlen( $hideprefix ) : 0;
		$product           = is_callable( array( $this, 'get_product' ) ) ? $this->get_product() : false;
		$order_item_name   = $this->get_name();

		foreach ( $meta_data as $meta ) {
			if ( empty( $meta->id ) || '' === $meta->value || ! is_scalar( $meta->value ) || ( $hideprefix_length && substr( $meta->key, 0, $hideprefix_length ) === $hideprefix ) ) {
				continue;
			}

			$meta->key     = rawurldecode( (string) $meta->key );
			$meta->value   = rawurldecode( (string) $meta->value );
			$attribute_key = str_replace( 'attribute_', '', $meta->key );
			$display_key   = wc_attribute_label( $attribute_key, $product );
			$display_value = wp_kses_post( $meta->value );

			if ( taxonomy_exists( $attribute_key ) ) {
				$term = get_term_by( 'slug', $meta->value, $attribute_key );
				if ( ! is_wp_error( $term ) && is_object( $term ) && $term->name ) {
					$display_value = $term->name;
				}
			}

			// Skip items with values already in the product details area of the product name.
			if ( ! $include_all && $product && $product->is_type( ProductType::VARIATION ) && wc_is_attribute_in_product_name( $display_value, $order_item_name ) ) {
				continue;
			}

			$formatted_meta[ $meta->id ] = (object) array(
				'key'           => $meta->key,
				'value'         => $meta->value,
				'display_key'   => apply_filters( 'woocommerce_order_item_display_meta_key', $display_key, $meta, $this ),
				'display_value' => wpautop( make_clickable( apply_filters( 'woocommerce_order_item_display_meta_value', $display_value, $meta, $this ) ) ),
			);
		}

		return apply_filters( 'woocommerce_order_item_get_formatted_meta_data', $formatted_meta, $this );
	}

	/*
	|--------------------------------------------------------------------------
	| Array Access Methods
	|--------------------------------------------------------------------------
	|
	| For backwards compatibility with legacy arrays.
	|
	*/

	/**
	 * OffsetSet for ArrayAccess.
	 *
	 * @param string $offset Offset.
	 * @param mixed  $value  Value.
	 */
	#[\ReturnTypeWillChange]
	public function offsetSet( $offset, $value ) {
		if ( 'item_meta_array' === $offset ) {
			foreach ( $value as $meta_id => $meta ) {
				$this->update_meta_data( $meta->key, $meta->value, $meta_id );
			}
			return;
		}

		if ( array_key_exists( $offset, $this->data ) ) {
			$setter = "set_$offset";
			if ( is_callable( array( $this, $setter ) ) ) {
				$this->$setter( $value );
			}
			return;
		}

		$this->update_meta_data( $offset, $value );
	}

	/**
	 * OffsetUnset for ArrayAccess.
	 *
	 * @param string $offset Offset.
	 */
	#[\ReturnTypeWillChange]
	public function offsetUnset( $offset ) {
		$this->maybe_read_meta_data();

		if ( 'item_meta_array' === $offset || 'item_meta' === $offset ) {
			$this->meta_data = array();
			return;
		}

		if ( array_key_exists( $offset, $this->data ) ) {
			unset( $this->data[ $offset ] );
		}

		if ( array_key_exists( $offset, $this->changes ) ) {
			unset( $this->changes[ $offset ] );
		}

		$this->delete_meta_data( $offset );
	}

	/**
	 * OffsetExists for ArrayAccess.
	 *
	 * @param string $offset Offset.
	 * @return bool
	 */
	#[\ReturnTypeWillChange]
	public function offsetExists( $offset ) {
		$this->maybe_read_meta_data();
		if ( 'item_meta_array' === $offset || 'item_meta' === $offset || array_key_exists( $offset, $this->data ) ) {
			return true;
		}
		return array_key_exists( $offset, wp_list_pluck( $this->meta_data, 'value', 'key' ) ) || array_key_exists( '_' . $offset, wp_list_pluck( $this->meta_data, 'value', 'key' ) );
	}

	/**
	 * OffsetGet for ArrayAccess.
	 *
	 * @param string $offset Offset.
	 * @return mixed
	 */
	#[\ReturnTypeWillChange]
	public function offsetGet( $offset ) {
		$this->maybe_read_meta_data();

		if ( 'item_meta_array' === $offset ) {
			$return = array();

			foreach ( $this->meta_data as $meta ) {
				$return[ $meta->id ] = $meta;
			}

			return $return;
		}

		$meta_values = wp_list_pluck( $this->meta_data, 'value', 'key' );

		if ( 'item_meta' === $offset ) {
			return $meta_values;
		} elseif ( 'type' === $offset ) {
			return $this->get_type();
		} elseif ( array_key_exists( $offset, $this->data ) ) {
			$getter = "get_$offset";
			if ( is_callable( array( $this, $getter ) ) ) {
				return $this->$getter();
			}
		} elseif ( array_key_exists( '_' . $offset, $meta_values ) ) {
			// Item meta was expanded in previous versions, with prefixes removed. This maintains support.
			return $meta_values[ '_' . $offset ];
		} elseif ( array_key_exists( $offset, $meta_values ) ) {
			return $meta_values[ $offset ];
		}

		return null;
	}

	/**
	 * Indicates if the current order item has an associated Cost of Goods Sold value.
	 *
	 * Derived classes representing line items that have a COGS value
	 * should override this method to return "true" and also the 'calculate_cogs_value_core' method.
	 *
	 * @since 9.5.0
	 *
	 * @return bool True if this line item has an associated Cost of Goods Sold value.
	 */
	public function has_cogs(): bool {
		return false;
	}

	/**
	 * Calculate the Cost of Goods Sold value and set it as the actual value for this line item.
	 *
	 * @since 9.5.0
	 *
	 * @return bool True if the value has been calculated successfully (and set as the actual value), false otherwise (and the value hasn't changed).
	 * @throws Exception The class doesn't implement its own version of calculate_cogs_value_core. Derived classes are expected to override that method when has_cogs returns true.
	 */
	public function calculate_cogs_value(): bool {
		if ( ! $this->has_cogs() || ! $this->cogs_is_enabled( __METHOD__ ) ) {
			return false;
		}

		$value = $this->calculate_cogs_value_core();

		/**
		 * Filter to modify the Cost of Goods Sold value that gets calculated for a given order item.
		 *
		 * @since 9.5.0
		 *
		 * @param float|null $value The value originally calculated, null if it was not possible to calculate it.
		 * @param WC_Order_Item $line_item The order item for which the value is calculated.
		 */
		$value = apply_filters( 'woocommerce_calculated_order_item_cogs_value', $value, $this );

		if ( is_null( $value ) ) {
			return false;
		}

		$this->set_cogs_value( (float) $value );
		return true;
	}

	// phpcs:disable Squiz.Commenting.FunctionComment.InvalidNoReturn

	/**
	 * Core method to calculate the Cost of Goods Sold value for this line item:
	 * it doesn't check if COGS is enabled at class or system level, doesn't fire hooks, and doesn't set the value as the current one for the line item.
	 *
	 * @return float|null The calculated value, or null if the value can't be calculated for some reason.
	 * @throws Exception The class doesn't implement its own version of this method. Derived classes are expected to override this method when has_cogs returns true.
	 */
	protected function calculate_cogs_value_core(): ?float {
		// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
		throw new Exception(
			sprintf(
				// translators: %1$s = class and method name.
				__( 'Method %1$s is not implemented. Classes overriding has_cogs must override this method too.', 'woocommerce' ),
				__METHOD__
			)
		);
		// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
	}

	// phpcs:enable Squiz.Commenting.FunctionComment.InvalidNoReturn

	/**
	 * Get the value of the Cost of Goods Sold for this order item.
	 *
	 * WARNING! If the Cost of Goods Sold feature is disabled this method will always return zero.
	 *
	 * @param string $context What the value is for. Valid values are view and edit.
	 * @return float The current value for this order item.
	 */
	public function get_cogs_value( $context = 'view' ): float {
		return (float) ( $this->has_cogs() && $this->cogs_is_enabled( __METHOD__ ) ? $this->get_prop( 'cogs_value', $context ) : 0 );
	}

	/**
	 * Set the value of the Cost of Goods Sold for this order item.
	 * Usually you'll want to use calculate_cogs_value instead.
	 *
	 * WARNING! If the Cost of Goods Sold feature is disabled this method will have no effect.
	 *
	 * @param float $value The value to set for this order item.
	 *
	 * @internal This method is intended for data store usage only, the value set here will be overridden by calculate_cogs_value.
	 */
	public function set_cogs_value( float $value ): void {
		if ( $this->has_cogs() && $this->cogs_is_enabled( __METHOD__ ) ) {
			$this->set_prop( 'cogs_value', $value );
		}
	}

	/**
	 * Returns the Cost of Goods Sold value in html format.
	 *
	 * @return string
	 */
	public function get_cogs_value_html(): string {
		if ( ! $this->cogs_is_enabled( __METHOD__ ) ) {
			return '';
		}

		if ( ! $this->has_cogs() ) {
			/**
			 * Filter to customize how a non-existing Cost of Goods Sold value for an order item (whose has_cogs method returns false) gets rendered to HTML.
			 *
			 * @param string $html The rendered HTML.
			 * @param WC_Order_Item $product The order item for which the "there's no cost" indication is rendered.
			 *
			 * @since 9.9.0
			 */
			return apply_filters( 'woocommerce_order_item_no_cogs_html', "<span class='na'>&ndash;</span>", $this );
		}

		$cogs_value      = $this->get_cogs_value();
		$cogs_value_html = wc_price( $cogs_value, array( 'currency' => $this->get_order()->get_currency() ) );

		/**
		 * Filter to customize how the Cost of Goods Sold value for an order item gets rendered to HTML.
		 *
		 * @param string $html The rendered HTML.
		 * @param float $value The cost value that is being rendered.
		 * @param WC_Order_Item $product The order item.
		 *
		 * @since 9.9.0
		 */
		return apply_filters( 'woocommerce_order_item_cogs_html', $cogs_value_html, $cogs_value, $this );
	}

	/**
	 * Get the "cost per unit" tooltip text for the "Cost" (of Goods Sold) column in the order details page.
	 *
	 * @return string "Cost per unit: (formatted cost with currency)" text.
	 */
	public function get_cogs_value_per_unit_tooltip_text(): string {
		if ( ! $this->cogs_is_enabled( __METHOD__ ) || ! $this->has_cogs() ) {
			return '';
		}

		$tooltip_text            = '';
		$quantity                = $this->get_quantity();
		$cogs_value              = $this->get_cogs_value();
		$cost_per_item           = 0;
		$formatted_cost_per_item = '';

		if ( $quantity > 0 && $cogs_value > 0 ) {
			$cost_per_item           = $cogs_value / $quantity;
			$formatted_cost_per_item = wc_price(
				$cost_per_item,
				array(
					'currency' => $this->get_order()->get_currency(),
					'in_span'  => false,
				)
			);
			/* translators: %s = formatted cost with currency symbol. */
			$tooltip_text = sprintf( __( 'Cost per unit: %s', 'woocommerce' ), $formatted_cost_per_item );
		}

		/**
		 * Filter to customize the text of the "Cost per unit" tooltip for the "Cost" (of Goods Sold) column in the order details page.
		 * If an empty string is returned then the tooltip won't be rendered.
		 *
		 * @param string $tooltip_text Original tooltip text, may be an empty string.
		 * @param float $cost_per_item The numerical value of the unit Cost of Goods Sold of the product.
		 * @param string $formatted_cost_per_item The unit Cost of Goods Sold of the product already formatted for display.
		 * @param WC_Order_Item $order_item The order item this filter is being fired for.
		 *
		 * @since 9.9.0
		 */
		return apply_filters( 'woocommerce_order_item_cogs_per_item_tooltip', $tooltip_text, $cost_per_item, $formatted_cost_per_item, $this );
	}

	/**
	 * Returns the refunded Cost of Goods Sold value in html format.
	 *
	 * @param float         $refunded_cost The refunded value.
	 * @param array|null    $wc_price_arg Arguments to be passed to wc_price, defaults to an array containing only the currency symbol.
	 * @param WC_Order|null $order Order that contains this line item, if null, get_order will be invoked.
	 *
	 * @return string
	 */
	public function get_cogs_refund_value_html( float $refunded_cost, ?array $wc_price_arg = null, ?WC_Order $order = null ): string {
		if ( ! $this->cogs_is_enabled( __METHOD__ ) || ! $this->has_cogs() ) {
			return '';
		}

		if ( $refunded_cost > 0 ) {
			$refunded_cost = -$refunded_cost;
		}
		$order ??= $this->get_order();
		$html    = $refunded_cost ? '<small class="refunded">' . wc_price( $refunded_cost, $wc_price_arg ?? array( 'currency' => $order->get_currency() ) ) . '</small>' : '';

		/**
		 * Filter to customize the refunded Cost of Goods Sold (COGS) value HTML for a given order item.
		 *
		 * @since 10.3.0
		 *
		 * @param string $refunded_html The formatted refunded COGS HTML.
		 * @param float  $refunded_cost The refunded cost value (always zero or a negative number).
		 * @param WC_Order_Item $item   The order item object.
		 * @param WC_Order $order       The order object.
		 */
		return apply_filters( 'woocommerce_order_item_cogs_refunded_html', $html, $refunded_cost, $this, $order );
	}

	/**
	 * Convert a legacy scalar tax value to array format.
	 *
	 * Legacy orders may have tax data stored as floats/strings
	 * instead of arrays keyed by tax rate ID. This method attempts to infer the
	 * appropriate tax rate ID from the order context.
	 *
	 * @since 10.5.0
	 *
	 * @param float|string   $value The legacy scalar tax value.
	 * @param WC_Order|false $order The order object, or false/null if unavailable.
	 * @return array Tax data as array, keyed by tax rate ID (or 0 if unknown).
	 */
	protected function convert_legacy_tax_value_to_array( $value, $order = null ) {
		$rate_id = 0;

		// Try to infer tax rate ID from order context.
		$tax_items = $order ? $order->get_taxes() : array();
		if ( ! empty( $tax_items ) ) {
			// Use the first tax rate ID from the order as a best-effort match.
			$first_tax_item = reset( $tax_items );
			if ( $first_tax_item ) {
				$rate_id = $first_tax_item->get_rate_id();
			}
		}

		$converted = array( $rate_id => $value );

		/**
		 * Filter the converted legacy tax value.
		 *
		 * Allows plugins to customize how legacy scalar tax values are converted
		 * to the expected array format.
		 *
		 * @since 10.5.0
		 *
		 * @param array        $converted The converted tax data array.
		 * @param float|string $value     The original legacy scalar value.
		 * @param WC_Order_Item $item     The order item being processed.
		 */
		return apply_filters( 'woocommerce_order_item_legacy_tax_conversion', $converted, $value, $this );
	}
}

Directory Contents

Dirs: 28 × Files: 115
Name Size Perms Modified Actions
abstracts DIR
- drwxr-xr-x 2026-07-28 11:37:05
Edit Download
admin DIR
- drwxr-xr-x 2026-07-28 11:37:06
Edit Download
blocks DIR
- drwxr-xr-x 2026-07-28 11:37:06
Edit Download
cli DIR
- drwxr-xr-x 2026-07-28 11:37:06
Edit Download
customizer DIR
- drwxr-xr-x 2026-07-28 11:37:06
Edit Download
data-stores DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
emails DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
export DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
gateways DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
import DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
integrations DIR
- drwxr-xr-x 2026-07-28 11:36:53
Edit Download
interfaces DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
legacy DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
libraries DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
log-handlers DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
payment-tokens DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
product-usage DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
queue DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
react-admin DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
rest-api DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
shipping DIR
- drwxr-xr-x 2026-07-28 11:36:53
Edit Download
shortcodes DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
theme-support DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
tracks DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
traits DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
walkers DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
wccom-site DIR
- drwxr-xr-x 2026-07-28 11:37:07
Edit Download
widgets DIR
- drwxr-xr-x 2026-07-28 11:37:08
Edit Download
class-wc-ajax.php
133.30 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-auth.php
12.69 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-autoloader.php
5.27 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-background-emailer.php
4.68 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-background-updater.php
3.45 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-brands-brand-settings-manager.php
1.78 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-brands-coupons.php
6.89 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-brands.php
35.04 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-breadcrumb.php
10.41 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cache-helper.php
13.51 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cart-fees.php
3.37 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cart-session.php
25.37 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cart-totals.php
28.48 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cart.php
75.50 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-checkout.php
50.48 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-cli.php
3.34 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-comments.php
23.08 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-countries.php
51.69 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-coupon.php
44.64 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-customer-download-log.php
3.37 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-customer-download.php
10.34 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-customer.php
33.28 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-data-exception.php
1.29 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-data-store.php
6.59 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-datetime.php
2.26 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-deprecated-action-hooks.php
6.59 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-deprecated-filter-hooks.php
7.34 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-discounts.php
36.64 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-download-handler.php
28.54 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-emails.php
39.64 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-embed.php
4.24 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-form-handler.php
48.17 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-frontend-scripts.php
34.44 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-geo-ip.php
30.43 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-geolite-integration.php
1.99 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-geolocation.php
11.46 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-https.php
4.33 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-install.php
107.57 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-integrations.php
1.28 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-log-levels.php
3.90 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-logger.php
9.41 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-meta-data.php
2.33 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-factory.php
8.98 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-coupon.php
4.08 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-fee.php
9.99 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-meta.php
5.80 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-product.php
18.33 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-shipping.php
9.58 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item-tax.php
6.50 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-item.php
22.70 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-query.php
2.52 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order-refund.php
5.99 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-order.php
78.37 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-payment-gateways.php
14.40 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-payment-tokens.php
6.24 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-post-data.php
39.09 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-post-types.php
29.65 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-privacy-background-process.php
1.79 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-privacy-erasers.php
13.61 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-privacy-exporters.php
14.69 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-privacy.php
17.22 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-attribute.php
7.87 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-download.php
13.18 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-external.php
4.98 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-factory.php
4.59 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-grouped.php
6.81 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-query.php
2.27 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-simple.php
2.70 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-variable.php
25.30 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-product-variation.php
20.22 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-query.php
37.55 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-rate-limiter.php
4.00 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-regenerate-images-request.php
7.74 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-regenerate-images.php
15.44 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-register-wp-admin-settings.php
5.05 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-rest-authentication.php
21.55 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-rest-exception.php
276 B lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-session-handler.php
24.57 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-shipping-rate.php
9.34 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-shipping-zone.php
13.08 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-shipping-zones.php
5.00 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-shipping.php
13.03 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-shortcodes.php
18.82 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-structured-data.php
24.96 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-tax.php
39.87 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-template-loader.php
20.42 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-tracker.php
51.50 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-validation.php
5.79 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-wc-webhook.php
32.24 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
class-woocommerce.php
63.94 KB lrw-r--r-- 2026-07-28 11:37:06
Edit Download
wc-account-functions.php
14.83 KB lrw-r--r-- 2026-07-28 11:37:07
Edit Download
wc-attribute-functions.php
22.81 KB lrw-r--r-- 2026-07-28 11:37:07
Edit Download
wc-brands-functions.php
4.17 KB lrw-r--r-- 2026-07-28 11:37:07
Edit Download
wc-cart-functions.php
21.58 KB lrw-r--r-- 2026-07-28 11:37:07
Edit Download
wc-conditional-functions.php
15.53 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-core-functions.php
79.00 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-coupon-functions.php
5.56 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-deprecated-functions.php
40.38 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-formatting-functions.php
49.91 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-interactivity-api-functions.php
2.43 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-notice-functions.php
8.49 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-order-functions.php
43.99 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-order-item-functions.php
5.03 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-order-step-logger-functions.php
5.97 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-page-functions.php
9.99 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-product-functions.php
69.18 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-rest-functions.php
13.93 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-stock-functions.php
17.43 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-template-functions.php
148.55 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-template-hooks.php
12.84 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-term-functions.php
24.63 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-update-functions.php
108.05 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-user-functions.php
36.36 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-webhook-functions.php
7.49 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
wc-widget-functions.php
2.01 KB lrw-r--r-- 2026-07-28 11:37:08
Edit Download
If ZipArchive is unavailable, a .tar will be created (no compression).
© 2026 0xNothings — Secure File Manager. All rights reserved. Built with ❤️ & Tailwind x Dark UI