LLMS_Order::get_access_status()
Get the current status of a student’s access
Description Description
Based on the access plan data stored on the order at the time of purchase.
Return Return
(string) 'inactive' If the order is refunded, failed, pending, etc... 'expired' If access has expired according to $this->get_access_expiration_date() 'active' Otherwise.
Source Source
File: includes/models/model.llms.order.php
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 | public function get_access_status() { $statuses = apply_filters( 'llms_order_allow_access_stasuses', array( 'llms-active', 'llms-completed', 'llms-pending-cancel', /** * Recurring orders can expire but still grant access * eg: 3monthly payments grants 1 year of access * on the 4th month the order will be marked as expired * but the access has not yet expired based on the data below. */ 'llms-expired', ) ); // If the order doesn't have one of the allowed statuses. // Return 'inactive' and don't bother checking expiration data. if ( ! in_array( $this->get( 'status' ), $statuses, true ) ) { return 'inactive'; } // Get the expiration date as a timestamp. $expires = $this->get_access_expiration_date( 'U' ); /** * A translated non-numeric string will be returned for lifetime access * so if we have a timestamp we should compare it against the current time * to determine if access has expired. */ if ( is_numeric( $expires ) ) { $now = llms_current_time( 'timestamp' ); // Expiration date is in the past // eg: the access has already expired. if ( $expires < $now ) { return 'expired'; } } // We're active. return 'active';} |
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
| Version | Description |
|---|---|
| 5.2.0 | Use stric type comparison. |
| 3.19.0 | Unknown. |
| 3.0.0 | Introduced. |