shopp_order_is_void()

find out if an order has been voided

shopp_order_is_void ( $id, $by )

@param int $id the order id or txn id
@param string $by (optional default:id) lookup by 'id', or 'trans'
@return bool|null true if voided, false if not voided, and null if order does not exist

Description

find out if an order has been voided

Example

lookup void status by order id

// lookup void status for order 200
if ( true === shopp_order_is_void(200) ) {
    // the order is void
}

lookup void status by transaction id

// lookup void status for transaction id L1E73DBDXHLMHNMQZ
if ( true === shopp_order_is_void( 'L1E73DBDXHLMHNMQZ', 'trans' ) ) {
    // the order is void
}

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar