Tribe__Tickets__Commerce__PayPal__Order::delete( bool $delete_attendees = true, bool $force_delete = false )

Deletes an Order and its related data from the database.

See also


Top ↑

Parameters

$delete_attendees

(bool) (Optional) Whether Attendees for the order should be deleted or not.

Default value: true

$force_delete

(bool) (Optional) Whether the Order deletion should be forced or not.

Default value: false


Top ↑

Return

(false|null|WP_Post) The delete operation exit status.


Top ↑

Source

File: src/Tribe/Commerce/PayPal/Order.php

	public function delete( $delete_attendees = true, $force_delete = false ) {
		/**
		 * Fires before an Order, and its related data, is deleted.
		 *
		 * @since 4.7
		 *
		 * @param WP_Post|false|null $post_id          The Order post ID
		 * @param bool               $delete_attendees Whether attendees should be deleted or not
		 * @param bool               $force_delete     Whether the Order deletion should be forced or not
		 * @param Tribe__Tickets__Commerce__PayPal__Order This Order object
		 */
		do_action( 'tribe_tickets_tpp_after_before_delete', $this->post_id, $delete_attendees, $force_delete, $this );

		/** @var Tribe__Tickets__Commerce__PayPal__Main $paypal */
		$paypal = tribe( 'tickets.commerce.paypal' );

		foreach ( $this->attendees as $attendee ) {
			if ( $delete_attendees ) {
				$paypal->delete_ticket( (int) $attendee['event_id'], (int) $attendee['attendee_id'] );
			}
			$this->remove_attendee( (int) $attendee['attendee_id'] );
		}

		$deleted = wp_delete_post( $this->post_id, $force_delete );

		/**
		 * Fires after an Order, and its related data, is deleted.
		 *
		 * @since 4.7
		 *
		 * @param WP_Post|false|null $deleted          The exit status of the delete operation
		 * @param bool               $delete_attendees Whether attendees have been deleted or not
		 * @param bool               $force_delete     Whether the Order deletion was forced or not
		 * @param Tribe__Tickets__Commerce__PayPal__Order This Order object
		 */
		do_action( 'tribe_tickets_tpp_after_after_delete', $deleted, $delete_attendees, $force_delete, $this );

		return $deleted;
	}

Top ↑

Changelog

Changelog
Version Description
4.7 Introduced.