llms_unenroll_student( int $user_id, int $product_id, string $new_status = 'expired', string $trigger = 'any' )

Remove a LifterLMS Student from a course or membership

Description Description

See also See also

  • LLMS_Student->unenroll(): the class method wrapped by this function

Top ↑

Parameters Parameters


(int) (Required) WP User ID.


(int) (Required) WP Post ID of the Course or Membership.


(string) (Optional) The value to update the new status with after removal is complete.

Default value: 'expired'


(string) (Optional) Only remove the student if the original enrollment trigger matches the submitted value. Passing "any" will remove regardless of enrollment trigger.

Default value: 'any'

Top ↑

Return Return


Top ↑

Source Source

File: includes/functions/llms.functions.person.php

 * @param string $val Cookie value.
 * @return bool
function llms_set_password_reset_cookie( $val = '' ) {

Top ↑

Changelog Changelog

Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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