Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

LLMS_Meta_Box_Order_Enrollment::save_delete_enrollment( int $post_id )

Delete enrollment data based on posted values.


Description Description


Parameters Parameters

$post_id

(int) (Required) WP_Post ID of the order.


Top ↑

Return Return

(void)


Top ↑

Source Source

File: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.enrollment.php

	private function save_delete_enrollment( $post_id ) {

		$order = llms_get_post( $post_id );

		// Switch the order status to Cancelled: it will also unenroll the student setting the enrollment status to 'cancelled' as well
		// @see `LLMS_Controller_Orders->error_order()`
		$order->set_status( 'cancelled' );

		// Completely remove any enrollment records related to the given product & order.
		llms_delete_student_enrollment( $order->get( 'user_id' ), $order->get( 'product_id' ), 'order_' . $order->get( 'id' ) );

		$order->add_note( __( 'Student enrollment records have been deleted.', 'lifterlms' ), true );

	}

Top ↑

Changelog Changelog

Changelog
Version Description
3.33.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.





Permalink: