Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20614 from rnaby/250618-120045 

@throws PHPDoc Fix
This commit is contained in:
Mike Jolley 2018-06-25 12:07:44 +01:00 committed by GitHub
parent 7fb101772f cb945a8816
commit 525ea24160
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
includes/wc-order-item-functions.php
View File

@ -15,7 +15,9 @@ defined( 'ABSPATH' ) || exit;
*
* @param int $order_id Order ID.
* @param array $item_array Items list.
* @return int|bool Item ID or false
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return int|bool Item ID or false
*/
function wc_add_order_item( $order_id, $item_array ) {
$order_id = absint( $order_id );
@ -45,6 +47,8 @@ function wc_add_order_item( $order_id, $item_array ) {
* @since 2.2
* @param int $item_id Item ID.
* @param array $args Either `order_item_type` or `order_item_name`.
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return bool True if successfully updated, false otherwise.
*/
function wc_update_order_item( $item_id, $args ) {
@ -63,7 +67,9 @@ function wc_update_order_item( $item_id, $args ) {
/**
* Delete an item from the order it belongs to based on item id.
*
* @param int $item_id Item ID.
* @param int $item_id Item ID.
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return bool
*/
function wc_delete_order_item( $item_id ) {
@ -91,6 +97,8 @@ function wc_delete_order_item( $item_id ) {
* @param string $meta_key Meta key.
* @param string $meta_value Meta value.
* @param string $prev_value Previous value (default: '').
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return bool
*/
function wc_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_value = '' ) {
@ -109,6 +117,8 @@ function wc_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_valu
* @param string $meta_key Meta key.
* @param string $meta_value Meta value.
* @param bool $unique If meta data should be unique (default: false).
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return int New row ID or 0.
*/
function wc_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique = false ) {
@ -129,6 +139,8 @@ function wc_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique = fal
* @param string $meta_key Meta key.
* @param string $meta_value Meta value (default: '').
* @param bool $delete_all Delete all meta data, defaults to `false`.
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return bool
*/
function wc_delete_order_item_meta( $item_id, $meta_key, $meta_value = '', $delete_all = false ) {
@ -146,6 +158,8 @@ function wc_delete_order_item_meta( $item_id, $meta_key, $meta_value = '', $dele
* @param int $item_id Item ID.
* @param string $key Meta key.
* @param bool $single Whether to return a single value. (default: true).
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return mixed
*/
function wc_get_order_item_meta( $item_id, $key, $single = true ) {
@ -157,6 +171,8 @@ function wc_get_order_item_meta( $item_id, $key, $single = true ) {
* Get order ID by order item ID.
*
* @param int $item_id Item ID.
*
* @throws Exception When `WC_Data_Store::load` validation fails.
* @return int
*/
function wc_get_order_id_by_order_item_id( $item_id ) {